WIP: structuring contents and about

.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

docs/.pages

@@ -1,7 +1,6 @@
 nav:
-  - index.md
+  - About
   - architecture
   - ref
   - howto
   - contributing
-  - license.md

docs/About/.pages

@@ -0,0 +1,3 @@
+nav:
+  - intro.md
+  - license.md

docs/About/intro.md

@@ -0,0 +1 @@
+---8<-- "README.md"

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

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