From e0a4bb0f8a44bd54bbf66b78c0888bc7c65017b9 Mon Sep 17 00:00:00 2001
From: Jordan Wiens <jordan@psifertex.com>
Date: Tue, 18 Mar 2025 16:51:34 -0400
Subject: migrate getting started docs into user guide, make default landing
 page

---
 docs/guide/index.md | 10 ----------
 mkdocs.yml          | 28 ++++++++++++++--------------
 2 files changed, 14 insertions(+), 24 deletions(-)

diff --git a/docs/guide/index.md b/docs/guide/index.md
index fb07c2d2..48734be4 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -2,16 +2,6 @@
 
 Welcome to the Binary Ninja User Guide. You'll notice two menus here. On the right is the table of contents for this main page of the user manual. On the left are links to larger topics that have their own pages, including:
 
-- [Plugins](plugins.md)
-- [Settings](settings.md)
-- [Projects](projects.md)
-- [Troubleshooting](troubleshooting.md)
-- [Objective-C](objectivec.md)
-- [Debugger](debugger/index.md)
-- [Migration Guide](migration/index.md)
-- [Types](types/index.md)
-[comment]: <> (When changing this list, make sure to update mkdocs.yml as well)
-
 ## Directories
 
 Binary Ninja stores information in two primary locations. The first is the binary path (wherever Binary Ninja is installed) and the second is the user folder for user-installed content.
diff --git a/mkdocs.yml b/mkdocs.yml
index 6e4e339a..a3a21b17 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -37,12 +37,12 @@ theme:
         - navigation.tracking
         - navigation.tabs
         - navigation.tabs.sticky
-        - navigation.sections
         - navigation.expand
-        - navigation.prune
+        - navigation.indexes # Consider revisiting this later if top-levels being clickable isn't obvious
         - navigation.top
         - content.code.copy
         - search.highlight
+        - toc.follow
 
     shortcuts:
         help: 191    # ?
@@ -65,6 +65,7 @@ plugins:
         enabled: !ENV [VALIDATE, False]
     - redirects:
         redirect_maps:
+            'index.md': 'getting-started.md'
             'guide/debugger.md': 'guide/debugger/index.md'
             'guide/remote-debugging.md': 'guide/debugger/remote-debugging.md'
             'guide/dbgeng-ttd.md': 'guide/debugger/dbgeng-ttd.md'
@@ -82,17 +83,16 @@ markdown_extensions:
         permalink: True
 
 nav:
-    - Home: 'index.md'
-    - Getting Started: 'getting-started.md'
-    # When updating here make sure to update guide/index.md as well
-    - User Guide:
-        - 'guide/index.md'
-        - Plugins: 'guide/plugins.md'
-        - Settings: 'guide/settings.md'
-        - Projects: 'guide/projects.md'
-        - Enterprise: 'guide/enterprise/index.md'
-        - Troubleshooting: 'guide/troubleshooting.md'
-        - Objective-C (Experimental): 'guide/objectivec.md'
+    - User Documentation:
+        - Getting Started: 'getting-started.md'
+        - User Guide:
+          - 'guide/index.md'
+          - Using Plugins: 'guide/plugins.md'
+          - All Settings: 'guide/settings.md'
+          - Projects: 'guide/projects.md'
+          - Enterprise: 'guide/enterprise/index.md'
+          - Troubleshooting: 'guide/troubleshooting.md'
+          - Objective-C (Experimental): 'guide/objectivec.md'
         - Debugger:
             - Overview: 'guide/debugger/index.md'
             - Remote Debugging: 'guide/debugger/remote-debugging.md'
@@ -113,7 +113,7 @@ nav:
             - Debug Info: 'guide/types/debuginfo.md'
             - Platform Types: 'guide/types/platformtypes.md'
             - C++ Types: 'guide/types/cpp.md'
-    - Developer Guide:
+    - Developer Documentation:
         - 'dev/index.md'
         - Cookbook: 'dev/cookbook.md'
         - Writing Plugins: 'dev/plugins.md'
-- 
cgit v1.3.1