Skip to content

Combined publication artifacts

Generated, published-style documentation artifacts. Files here are build output, not authored sources. Committed so the rendered artifacts are reviewable on GitHub without a local rebuild.

Artifacts

  • openapi.json — ✅ committed. OpenAPI 3 spec for the dashboard BFF HTTP surface (/api/*), generated from the FastAPI app schema by generate_reference_docs.py and drift-gated (--check) in CI. This is the BFF contract the SPA's typed client is generated from (since 0.4.0, ADR-010) — not the kneo-serv /v1 spec.
  • Combined handout (kneo-dash-operator-guide.md) — ✅ generated (since 0.7.0). A single-file, offline-readable operator guide stitched from docs/user/*.md by generate_combined_docs.py, with cross-guide links rewritten to namespaced in-document anchors. Drift-gated (--check) in ci.yml + release.yml, and its intra-document anchors are guarded by backend/tests/test_combined_docs.py. The online site is canonical; this is the offline convenience copy. (The printable PDF renders at Pre-publish via script/render_pdf.py — generated, not committed; ships as a release attachment.)

Not here

  • Release notes live in docs/releases/.
  • Authored user docs live in docs/user/.

Both artifacts are committed, drift-gated (--check), and regenerated each cut. (The printable PDF renders at Pre-publish via render_pdf.py (0.8.0 E4) — generated, not committed.)

Pages

Files