From b7ccd6e94f365a41ff155a9c1c5a784264cb8d74 Mon Sep 17 00:00:00 2001
From: Gerard Vermeulen <gerard.vermeulen@posteo.net>
Date: Thu, 20 Jun 2024 12:06:24 +0200
Subject: [PATCH] Improve `which-key-mode' usage and add notes.

---
 README.org | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/README.org b/README.org
index 2dfcb17..85871eb 100644
--- a/README.org
+++ b/README.org
@@ -223,12 +223,12 @@ of [[info:emacs#Saving Customizations][saving customizations (info)]].
  lazy-count-prefix-format nil
  lazy-count-suffix-format " (%s/%s)"
  lazy-highlight-initial-delay 1.0
+ max-mini-window-height 0.5 ; Prevent `which-key-mode' paging (try `C-x')!
  mode-line-compact t
  next-error-message-highlight t
  recentf-max-saved-items 100
  recentf-mode t
  save-place-mode t
- savehist-additional-variables nil ; Docstring is not OK!
  savehist-mode t
  scroll-bar-mode nil
  tab-always-indent 'complete
@@ -1030,9 +1030,18 @@ looks for files.
 Table [[tab:basic-key-bindings]] lists basic key bindings.  Enabling
 =which-key-mode= is another way of associating key bindings with commands.
 Execute src_emacs-lisp[:results none]{(find-library "which-key")} to check
-whether this library is builtin.  This setup does not enable =which-key-mode=
-because of rare interference with for instance a process that the =compile=
-command launches.
+whether this library is builtin.  Notes:
+1. This setup does not enable =which-key-mode= because of rare interference with
+   for instance a process that the =compile= command launches.
+2. ChatGPT bullshits on "How to page in =which-key-mode= on Emacs".
+3. Execute src_emacs-lisp[:results none]{(setopt max-mini-window-height 0.5)} to
+   make =which-key-mode= display all keys without paging (try "C-x").
+4. Execute src_emacs-lisp[:results none]{(which-key-setup-side-window-right)} to
+   *enable* =which-key= paging support (use fn-F1 on Darwin).  Setting
+   =max-mini-window-height= is the easiest solution.
+5. Execute src_emacs-lisp[:results none]{(which-key-setup-minibuffer)} to
+   *disable* =which-key= paging support (and display the first =which-key-mode=
+   page in the minibuffer).
 
 #+attr_latex: :booktabs yes :float table
 #+caption[Basic key bindings]: