Auto-generate nav & branch preview docs

.github/mkdocs.yml

@@ -50,58 +50,66 @@ plugins:
       background: light-dark(white, black)
       shadow: false
 
+# Auto-generated by scripts/generate-docs.py — do not edit manually.
+# Kept in version control so `mkdocs serve` works without running the generator.
 nav:
   - Home: index.md
   - Workflows:
       - Overview: workflows/index.md
       - iOS:
           - workflows/ios/index.md
-          - Test: workflows/ios/selfhosted-test.md
+          - Build (Deprecated): workflows/ios/selfhosted-build.md
           - Nightly Build: workflows/ios/selfhosted-nightly-build.md
-          - On-demand Build: workflows/ios/selfhosted-on-demand-build.md
+          - On-Demand Build: workflows/ios/selfhosted-on-demand-build.md
           - Release: workflows/ios/selfhosted-release.md
-          - Build (Deprecated): workflows/ios/selfhosted-build.md
+          - Test: workflows/ios/selfhosted-test.md
       - iOS + KMP:
           - workflows/ios-kmp/index.md
-          - Test: workflows/ios-kmp/selfhosted-test.md
           - Build: workflows/ios-kmp/selfhosted-build.md
           - Release: workflows/ios-kmp/selfhosted-release.md
+          - Test: workflows/ios-kmp/selfhosted-test.md
       - Android:
           - workflows/android/index.md
-          - PR Check: workflows/android/cloud-check.md
-          - Nightly Build: workflows/android/cloud-nightly-build.md
-          - Release (Firebase): workflows/android/cloud-release-firebase.md
-          - Release (Google Play): workflows/android/cloud-release-googleplay.md
           - Generate Baseline Profiles: workflows/android/cloud-generate-baseline-profiles.md
+          - Nightly Build: workflows/android/cloud-nightly-build.md
+          - PR Check: workflows/android/cloud-check.md
+          - Release (Firebase): workflows/android/cloud-release-firebaseAppDistribution.md
+          - Release (Google Play): workflows/android/cloud-release-googlePlay.md
       - KMP:
           - workflows/kmp/index.md
-          - Detect Changes: workflows/kmp/cloud-detect-changes.md
           - Combined Nightly Build: workflows/kmp/combined-nightly-build.md
+          - Detect Changes: workflows/kmp/cloud-detect-changes.md
       - Universal:
           - workflows/universal/index.md
-          - Workflows Lint: workflows/universal/workflows-lint.md
           - Cloud Backup: workflows/universal/cloud-backup.md
           - Self-hosted Backup: workflows/universal/selfhosted-backup.md
+          - Workflows Lint: workflows/universal/workflows-lint.md
   - Actions:
       - Overview: actions/index.md
-      - Android:
-          - actions/android/index.md
-          - Setup Environment: actions/android/setup-environment.md
-          - Check: actions/android/check.md
-          - Build Firebase: actions/android/build-firebase.md
-          - Build Google Play: actions/android/build-googleplay.md
-          - Generate Baseline Profiles: actions/android/generate-baseline-profiles.md
       - iOS:
           - actions/ios/index.md
           - Export Secrets: actions/ios/export-secrets.md
-          - Fastlane Test: actions/ios/fastlane-test.md
           - Fastlane Beta: actions/ios/fastlane-beta.md
           - Fastlane Release: actions/ios/fastlane-release.md
-          - KMP Build: actions/ios/kmp-build.md
+          - Fastlane Test: actions/ios/fastlane-test.md
+      - iOS + KMP:
+          - actions/ios-kmp/index.md
+          - Build: actions/ios-kmp/build.md
+      - Android:
+          - actions/android/index.md
+          - Build Firebase: actions/android/build-firebase.md
+          - Build Google Play: actions/android/build-googlePlay.md
+          - Check: actions/android/check.md
+          - Generate Baseline Profiles: actions/android/generate-baseline-profiles.md
+          - Setup Environment: actions/android/setup-environment.md
+      - KMP:
+          - actions/kmp/index.md
+          - Detect Changes: actions/kmp/detect-changes.md
+      - Universal:
+          - actions/universal/index.md
+          - Detect Changes & Changelog: actions/universal/detect-changes-and-generate-changelog.md
       - Utility:
           - actions/utility/index.md
-          - KMP Detect Changes: actions/utility/kmp-detect-changes.md
-          - Detect Changes & Changelog: actions/utility/detect-changes-changelog.md
           - JIRA Transition Tickets: actions/utility/jira-transition-tickets.md
 
 copyright: Made with ❤️‍🔥 at Futured

.github/scripts/config.py

@@ -30,6 +30,7 @@
 #   source             – relative path to the YAML file
 #   category           – category id (must exist in CATEGORY_LABELS)
 #   title              – display title (default: YAML `name:` field)
+#   nav_title          – short title for the mkdocs nav sidebar
 #   output             – output markdown path
 #   runner             – runner label shown in docs
 #   not_reusable       – bool; True hides the "Usage" snippet (auto-detected
@@ -43,6 +44,7 @@
 #   source             – relative path to action.yml
 #   category           – category id (must exist in CATEGORY_LABELS)
 #   title              – display title (default: YAML `name:` field)
+#   nav_title          – short title for the mkdocs nav sidebar
 #   output             – output markdown path
 #   readme             – relative path to a README.md to embed (auto-detected)
 #
@@ -54,6 +56,34 @@
     },
     "workflows-lint": {
         "not_reusable": True,
+        "nav_title": "Workflows Lint",
+    },
+    "android-cloud-check": {
+        "nav_title": "PR Check",
+    },
+    "android-cloud-release-firebaseAppDistribution": {
+        "nav_title": "Release (Firebase)",
+    },
+    "android-cloud-release-googlePlay": {
+        "nav_title": "Release (Google Play)",
+    },
+    "kmp-combined-nightly-build": {
+        "nav_title": "Combined Nightly Build",
+    },
+    "android-build-firebase": {
+        "nav_title": "Build Firebase",
+    },
+    "android-build-googlePlay": {
+        "nav_title": "Build Google Play",
+    },
+    "android-setup-environment": {
+        "nav_title": "Setup Environment",
+    },
+    "ios-export-secrets": {
+        "nav_title": "Export Secrets",
+    },
+    "universal-detect-changes-and-generate-changelog": {
+        "nav_title": "Detect Changes & Changelog",
     },
 }
 

.github/scripts/generate-docs.py

@@ -27,6 +27,7 @@
 sys.path.insert(0, str(ROOT_DIR))
 
 from scripts.config import ACTIONS, CATEGORY_LABELS, WORKFLOWS
+from scripts.nav_generator import build_nav, inject_nav, render_nav_yaml
 from scripts.enrichers.ai_enricher import AIEnricher
 from scripts.enrichers.base import BaseEnricher, EnrichmentResult
 from scripts.enrichers.readme_enricher import ReadmeEnricher
@@ -260,6 +261,16 @@ def main() -> None:
     )
     print(f"  Written: docs/actions/index.md")
 
+    # -------------------------------------------------------------------
+    # Generate nav in mkdocs.yml
+    # -------------------------------------------------------------------
+    print("\nGenerating nav...")
+    nav = build_nav(WORKFLOWS, ACTIONS, CATEGORY_LABELS)
+    nav_yaml = render_nav_yaml(nav)
+    mkdocs_path = ROOT_DIR / "mkdocs.yml"
+    inject_nav(mkdocs_path, nav_yaml)
+    print(f"  Updated: {mkdocs_path.relative_to(ROOT_DIR)}")
+
     # -------------------------------------------------------------------
     # Summary
     # -------------------------------------------------------------------