From ebdee8c974d9253e28a65ab0cd4e51f64719c339 Mon Sep 17 00:00:00 2001
From: Fang Yi Liu <fangyiliu@gmail.com>
Date: Tue, 10 Sep 2024 14:28:37 -0700
Subject: [PATCH] WIP: structuring contents and about

---
 .pre-commit-config.yaml     |  4 ++--
 docs/.pages                 |  3 +--
 docs/About/.pages           |  3 +++
 docs/About/intro.md         |  1 +
 docs/{ => About}/license.md |  0
 docs/index.md               | 42 ++++++++++++++++++++++++++++++++++++-
 mkdocs.yml                  |  6 +++++-
 7 files changed, 53 insertions(+), 6 deletions(-)
 create mode 100644 docs/About/.pages
 create mode 100644 docs/About/intro.md
 rename docs/{ => About}/license.md (100%)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 4bf8927a..ab0a611f 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -141,8 +141,8 @@ repos:
         exclude: |
           (?x)^(
             .github/ISSUE_TEMPLATE/|
-            docs/index.md$|
-            docs/license.md$
+            docs/About.intro.md$|
+            docs/About.license.md$
           )
         additional_dependencies:
           - mdformat-admon
diff --git a/docs/.pages b/docs/.pages
index 4441258b..d2b9fa70 100644
--- a/docs/.pages
+++ b/docs/.pages
@@ -1,7 +1,6 @@
 nav:
-  - index.md
+  - About
   - architecture
   - ref
   - howto
   - contributing
-  - license.md
diff --git a/docs/About/.pages b/docs/About/.pages
new file mode 100644
index 00000000..f1bafd88
--- /dev/null
+++ b/docs/About/.pages
@@ -0,0 +1,3 @@
+nav:
+  - intro.md
+  - license.md
diff --git a/docs/About/intro.md b/docs/About/intro.md
new file mode 100644
index 00000000..7edd4112
--- /dev/null
+++ b/docs/About/intro.md
@@ -0,0 +1 @@
+---8<-- "README.md"
diff --git a/docs/license.md b/docs/About/license.md
similarity index 100%
rename from docs/license.md
rename to docs/About/license.md
diff --git a/docs/index.md b/docs/index.md
index 612c7a5e..d2066ac7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,41 @@
---8<-- "README.md"
+# Contents
+
+1. About
+    - [Introduction](intro.md)
+    - [License](license.md)
+1. Topics
+    - Authentication
+    - User Permissions
+    - Projects
+    - Program Areas
+    - Events
+    - Affiliates
+1. Tutorials
+    - Create a simple React client app
+1. Guides
+    - How to set up X
+1. Reference
+    - REST API
+    - Code Docs
+1. Contributing
+    - Developer
+        - Joining the Team
+        - Development Environment
+        - Working with Issues
+        - Working with Git
+        - Pull Requests
+        - Developer Guides
+            - Add new model and API endpoints
+            - Create initial data scripts
+            - Run backend in venv
+        - Maintainer Guides
+            - Update build dependencies
+            - Merge pull requests
+        - Tools
+            - Scripts
+            - MkDocs
+            - Docker
+            - Pre-commit
+            - uv
+    - Project Management
+    - Documentation
diff --git a/mkdocs.yml b/mkdocs.yml
index 67e14b49..22edf87b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -12,7 +12,11 @@ theme:
     - content.code.select
     - navigation.expand
     - navigation.indexes
-    - navigation.sections
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.tracking
 
 plugins:
   - search