Add a public API wiki at /wiki

Builds docs/ into a static site via mkdocs + mkdocs-material in its own Docker build stage (docs-builder), so mkdocs itself never ends up in the runtime image -- only the rendered HTML does, mounted at /wiki alongside the existing /docs OpenAPI schema (unconditionally, unlike /docs, since this is curated content meant to be public regardless of AURORA_API_DOCS_ENABLED). docs/aurora-core-spec.md (the internal build spec, referenced by "section N" comments throughout the codebase) is excluded from the built site entirely via exclude_docs, not just left out of the nav -- it was never meant for public consumption. Co-Authored-By: Claude Sonnet 5 <[email protected]>
2026-09-06 06:04:59 -05:00
parent 4403305da6
commit 56a03f9cfe
7 changed files with 113 additions and 1 deletions
@@ -0,0 +1,51 @@
+site_name: Aurora Core
+site_description: API documentation for Aurora Core, the metadata backend behind AMDBS.
+site_url: https://api.amdbs.net/wiki/
+docs_dir: docs
+site_dir: site
+
+# The build spec is an internal planning document (build-phase instructions
+# referenced by "section N" comments throughout app/), not documentation
+# for API consumers -- excluded from the public wiki entirely rather than
+# just left out of the nav (exclude_docs stops it from being copied into
+# the built site at all, so it isn't reachable at a guessed URL either).
+exclude_docs: |
+  aurora-core-spec.md
+
+nav:
+  - Home: index.md
+  - API Reference: api.md
+  - Architecture: architecture.md
+  - Database: database.md
+  - Entity relationships: erd.md
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.top
+    - toc.follow
+    - content.code.copy
+    - search.suggest
+
+markdown_extensions:
+  - tables
+  - fenced_code
+  - toc:
+      permalink: true
+  - pymdownx.highlight
+  - pymdownx.superfences