From 5f0ebdf2e05a45c42fb7f052a678e6193e19b44d Mon Sep 17 00:00:00 2001
From: Yusef Aslam <82241382+yusi1@users.noreply.github.com>
Date: Wed, 5 Nov 2025 02:45:57 +0000
Subject: [PATCH] docs(minimap): update & expand

---
 modules/ui/minimap/README.org | 49 +++++++++++++++++++++++------------
 1 file changed, 33 insertions(+), 16 deletions(-)

diff --git a/modules/ui/minimap/README.org b/modules/ui/minimap/README.org
index fee7cbf45..de7c09f10 100644
--- a/modules/ui/minimap/README.org
+++ b/modules/ui/minimap/README.org
@@ -23,22 +23,30 @@ feature found in many other editors.
 # This section will be machine generated. Don't edit it by hand.
 /This module does not have a changelog yet./
 
-* TODO Usage
-#+begin_quote
- 󱌣 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
-#+end_quote
+* Usage
+Press [[kbd:][SPC t m]] to toggle the minimap.
 
-A minimap which provides an overview of the current buffer to the side,
-displaying the currently visible region and the current line. You can left-click
-and drag to scroll along the buffer, or right-click anywhere to jump to there.
+A minimap provides an overview of the current buffer to the side, displaying the
+currently visible region and the current line. You can left-click inside the
+minimap to create a region, or scroll to move the minimap up & down.
 
-* TODO Configuration
-#+begin_quote
- 󱌣 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
-#+end_quote
+* Configuration
+There are a number of options provided by the =demap.el= package this module
+is based on. The easiest way to see all of them is [[kbd:][SPC h v demap]].
 
-There are a number of options provided by the =minimap.el= package this module
-is based on. The easiest way to see all of them is [[kbd:][SPC h v minimap]].
+** Changing the side that the minimap window opens in
+You can change the variable [[var:demap-minimap-window-side][demap-minimap-window-side]] which controls the side of
+the frame the minimap window opens in, it supports these options:
+- =right=
+- =left=
+
+** Changing the width of the minimap window
+The [[var:demap-minimap-window-width][demap-minimap-window-width]] variable controls the width of the minimap
+window, by default it is set to =20=.
+
+** Changing the name of the minimap buffer
+The [[var:demap-minimap-default-name][demap-minimap-default-name]] variable controls the name of the minimap buffer,
+by default it is set to ="**Minimap**"=.
 
 * Troubleshooting
 /There are no known problems with this module./ [[doom-report:][Report one?]]
@@ -47,6 +55,15 @@ is based on. The easiest way to see all of them is [[kbd:][SPC h v minimap]].
 /This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
 
 * TODO Appendix
-#+begin_quote
- 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
-#+end_quote
+** Variables
+- demap-minimap-change-major-mode-hook
+- demap-minimap-default-name
+- demap-minimap-window-width
+- demap-minimap-window-side
+- demap-minimap-kill-hook
+- demap-minimap-construct-hook
+- demap-minimap-window-set-hook
+- demap-minimap-change-functions
+- demap-minimap-window-sleep-hook
+- demap-minimap-protected-variables
+- demap-minimap-close-kill-minimap-p