From 3f6e19b8b48b27b77810c469b9baa3e5b25c9af9 Mon Sep 17 00:00:00 2001
From: Nire Bryce <nire@computernope.net>
Date: Sat, 1 Jun 2024 16:25:15 -0400
Subject: [PATCH] docs(mkdocs) add display index preferences section

---
 docs/common-workflows/set-display-index.md | 17 +++++++++++++++++
 mkdocs.yml                                 |  1 +
 2 files changed, 18 insertions(+)
 create mode 100644 docs/common-workflows/set-display-index.md

diff --git a/docs/common-workflows/set-display-index.md b/docs/common-workflows/set-display-index.md
new file mode 100644
index 00000000..d702c873
--- /dev/null
+++ b/docs/common-workflows/set-display-index.md
@@ -0,0 +1,17 @@
+# Setting a Given Display to a Specific Index
+
+If you would like `komorebi` to remember monitor index positions, you will need to set the `display_index_preferences`
+configuration option in the static configuration file.
+
+Display IDs can be found using `komorebic monitor-information`.
+
+Then, in `komorebi.json`, you simply need to specify the preferred index position for each display ID:
+
+```json
+{
+  "display_index_preferences": {
+    "0": "DEL4310-5&1a6c0954&0&UID209155",
+    "1": "<another-display_id>"
+  }
+}
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index a8991ba3..eeec4013 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -68,6 +68,7 @@ nav:
       - common-workflows/mouse-follows-focus.md
       - common-workflows/custom-layouts.md
       - common-workflows/dynamic-layout-switching.md
+      - common-workflows/set-display-index.md
   - Release notes:
       - release/v0-1-22.md
   - Configuration reference: https://komorebi.lgug2z.com/schema