Add a public API wiki at /wiki
CI / lint (push) Canceled after 0s
CI / typecheck (push) Canceled after 0s
CI / unit-tests (push) Canceled after 0s
CI / integration-tests (push) Canceled after 0s
CI / container-build (push) Canceled after 0s
CI / dependency-audit (push) Canceled after 0s
CI / lint (push) Canceled after 0s
CI / typecheck (push) Canceled after 0s
CI / unit-tests (push) Canceled after 0s
CI / integration-tests (push) Canceled after 0s
CI / container-build (push) Canceled after 0s
CI / dependency-audit (push) Canceled after 0s
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]>
This commit is contained in:
co-authored by
Claude Sonnet 5
parent
4403305da6
commit
56a03f9cfe
+11
@@ -94,6 +94,17 @@ app.mount(
|
||||
name="media",
|
||||
)
|
||||
|
||||
# Public API documentation (mkdocs, built from docs/ -- see
|
||||
# docker/api.Dockerfile's docs-builder stage and mkdocs.yml). Unlike /docs
|
||||
# (the auto-generated OpenAPI schema, gated by AURORA_API_DOCS_ENABLED
|
||||
# since it can reveal more raw internal detail), this is curated,
|
||||
# intentionally public content -- always mounted regardless of that flag.
|
||||
# The directory only exists in the built Docker image; ensure it's present
|
||||
# so a local dev server that hasn't run `mkdocs build` doesn't crash on
|
||||
# startup, same reasoning as MEDIA_ROOT above.
|
||||
Path("wiki").mkdir(parents=True, exist_ok=True)
|
||||
app.mount("/wiki", StaticFiles(directory="wiki", html=True), name="wiki")
|
||||
|
||||
|
||||
@app.middleware("http")
|
||||
async def request_context_middleware(
|
||||
|
||||
Reference in New Issue
Block a user