Change nav generation

Author: sntxerror

mkdocs.yml

@@ -88,24 +88,24 @@ nav:
   - Use Cases: ecosystem/use-cases/index.md
 - Modules:
   - Modules: modules/index.md
-  - mod-clk: modules/mod-clk/README.md
-  - mod-comp: modules/mod-comp/README.md
-  - mod-delay: modules/mod-delay/README.md
-  - mod-env: modules/mod-env/README.md
-  - mod-eq: modules/mod-eq/README.md
-  - mod-in-63: modules/mod-in-63/README.md
-  - mod-jacket: modules/mod-jacket/README.md
-  - mod-key: modules/mod-key/README.md
-  - mod-lpg: modules/mod-lpg/README.md
-  - mod-midi: modules/mod-midi/README.md
-  - mod-mix: modules/mod-mix/README.md
-  - mod-noise: modules/mod-noise/README.md
-  - mod-out-35: modules/mod-out-35/README.md
-  - mod-out-63: modules/mod-out-63/README.md
-  - mod-sat: modules/mod-sat/README.md
-  - mod-seq: modules/mod-seq/README.md
-  - mod-vcf: modules/mod-vcf/README.md
-  - mod-vco: modules/mod-vco/README.md
+  - counter: modules/mod-clk/README.md
+  - compressor: modules/mod-comp/README.md
+  - delay: modules/mod-delay/README.md
+  - envelope: modules/mod-env/README.md
+  - equalizer: modules/mod-eq/README.md
+  - input 6.3: modules/mod-in-63/README.md
+  - jacket 3.5mm: modules/mod-jacket/README.md
+  - stylo: modules/mod-key/README.md
+  - low-pass gate: modules/mod-lpg/README.md
+  - midi - cv: modules/mod-midi/README.md
+  - vca / mixer: modules/mod-mix/README.md
+  - noise + s&h: modules/mod-noise/README.md
+  - output 3.5: modules/mod-out-35/README.md
+  - output 6.3: modules/mod-out-63/README.md
+  - saturator: modules/mod-sat/README.md
+  - sequencer: modules/mod-seq/README.md
+  - filter: modules/mod-vcf/README.md
+  - oscillator: modules/mod-vco/README.md
 - Specification:
   - Specification: specification/index.md
   - Mechanical: specification/mechanical.md

scripts/update_nav.py

@@ -2,13 +2,29 @@
 """
 Update mkdocs.yml with module navigation entries.
 Scans docs/modules/ for mod-* directories and updates the nav section.
+Extracts H1 titles from README.md files for navigation labels.
 """
 
 import yaml
+import re
 from pathlib import Path
 
+def get_h1_title(readme_path):
+    """Extract the first H1 title from a README.md file."""
+    try:
+        with open(readme_path, 'r', encoding='utf-8') as f:
+            for line in f:
+                line = line.strip()
+                if line.startswith('# '):
+                    # Remove the "# " prefix and return the title as-is
+                    title = line[2:].strip()
+                    return title
+        return None
+    except Exception:
+        return None
+
 def get_module_list():
-    """Scan docs/modules for mod-* directories."""
+    """Scan docs/modules for mod-* directories and extract titles."""
     modules_dir = Path("docs/modules")
     if not modules_dir.exists():
         return []
@@ -18,7 +34,8 @@ def get_module_list():
         if item.is_dir() and item.name.startswith("mod-"):
             readme = item / "README.md"
             if readme.exists():
-                modules.append(item.name)
+                title = get_h1_title(readme) or item.name
+                modules.append((item.name, title))
 
     return modules
 
@@ -38,13 +55,13 @@ def update_mkdocs_yml():
         print("Error: nav section not found in mkdocs.yml")
         return
 
-    # Get module list
+    # Get module list with titles
     modules = get_module_list()
 
     # Build modules nav section
     modules_nav = [{"Modules": "modules/index.md"}]
-    for module in modules:
-        modules_nav.append({module: f"modules/{module}/README.md"})
+    for folder_name, title in modules:
+        modules_nav.append({title: f"modules/{folder_name}/README.md"})
 
     # Find and update the Modules section in nav
     nav = config['nav']