Add: [package]s sideline and helpful

2 files changed, 70 insertions, 6 deletions

diff --git a/shoshimacs.el b/shoshimacs.el
index b210f6e..5e787f3 100644
--- a/shoshimacs.el
+++ b/shoshimacs.el
@@ -92,8 +92,8 @@
   g magit
   h info
   i consult-imenu
-  j describe-function
-  k describe-variable
+  j helpful-function
+  k helpful-variable
   n tab-next
   p project-prefix-map
   s consult-git-grep
@@ -339,5 +339,20 @@ Saves to a temp file and puts the filename in the kill ring."
     (message filename)))
 
 (package-install 'windresize)
+
+(package-install 'helpful)
+
+(xah-fly--define-keys
+ xah-fly-leader-key-map
+ '(("h h" . helpful-callable)
+   ("h k" . helpful-key)
+   ("h n" . helpful-variable)
+   ("h x" . helpful-command)))
+
+(package-install 'sideline)
+
+(package-install 'sideline-flymake)
+(setq sideline-backends-left '(sideline-flymake))
+
 (provide 'shoshimacs)
 ;;; shoshimacs.el ends here
diff --git a/shoshimacs.org b/shoshimacs.org
index 97520a4..04fe728 100644
--- a/shoshimacs.org
+++ b/shoshimacs.org
@@ -339,8 +339,8 @@ bit of ergonomics essentially avoiding some parens and quotes 😂
     g magit
     h info
     i consult-imenu
-    j describe-function
-    k describe-variable
+    j helpful-function
+    k helpful-variable
     n tab-next
     p project-prefix-map
     s consult-git-grep
@@ -825,7 +825,7 @@ I primarily use SBCL, so I set it as the ~inferior-lisp-program~
  (setq inferior-lisp-program "sbcl")
 #+end_src
 
-*** SLY
+*** COMMENT SLY
 
 #+begin_src emacs-lisp
   (package-install 'sly)
@@ -838,7 +838,13 @@ I primarily use SBCL, so I set it as the ~inferior-lisp-program~
 #+end_src
 
 
-*** COMMENT Slime
+*** Slime
+
+#+begin_src shell
+  (package-install 'slime)
+#+end_src
+
+**** COMMENT Manual Install
 The ~slime~ package v2.26.1 in the nongnu repo seems to have an issue with
 emacs 28.1 (?) so I'm installing it from source.
 
@@ -1398,6 +1404,49 @@ Saves to a temp file and puts the filename in the kill ring."
   (package-install 'windresize)
 #+end_src
 
+** helpful
+
+Helpful is a package that enhances the default Emacs help buffers.
+I'm remapping the xah fly keys that point at the corresponding describe-
+commands.
+
+#+begin_src emacs-lisp
+  (package-install 'helpful)
+
+  (xah-fly--define-keys
+   xah-fly-leader-key-map
+   '(("h h" . helpful-callable)
+     ("h k" . helpful-key)
+     ("h n" . helpful-variable)
+     ("h x" . helpful-command)))
+#+end_src
+
+** sideline
+
+This library provides the frontend UI to display information either
+on the left/right side of the buffer window.
+
+1) You would need to first set up the backends,
+
+  (setq sideline-backends-left '(sideline-flycheck))
+
+2) Then enable the sideline in the target buffer,
+
+  M-x sideline-mode
+
+#+begin_src emacs-lisp
+  (package-install 'sideline)
+#+end_src
+
+*** sideline-flymake
+
+Adds flymake messages to the sideline UI.
+
+#+begin_src emacs-lisp
+  (package-install 'sideline-flymake)
+  (setq sideline-backends-left '(sideline-flymake))
+#+end_src
+
 * COMMENT scratch
 
 #+begin_src emacs-lisp :var buffer=(current-buffer)