Combined publication artifacts¶
Generated, published-style documentation artifacts. Files here are build output, not authored sources — the canonical source for each piece is referenced inline below. The reason this directory exists under version control is so the committed PDFs, HTMLs, and JSON are reviewable on GitHub without rebuilding locally.
Artifacts¶
- openapi.json — OpenAPI 3 spec for the HTTP API. Generated from the FastAPI app schema by
generate_reference_docs.py.
Combined handouts¶
Three rolled-up reading paths, each stitching together canonical
docs/user/*.md sources by demoting headings and rewriting links.
Markdown sources here are regenerated by
generate_combined_docs.py;
PDFs and print-HTMLs are rendered by
render_combined_handouts.py.
- Tutorial (.md, .pdf, .html) —
quickstart.md,tutorial_custom_tool.md,tutorial_postgres_deployment.md,human_in_the_loop.md. - Reference (.md, .pdf, .html) —
cli.md,cli_reference.md,service_api.md,environment.md,examples.md,project_config.md. - Operation guide (.md, .pdf, .html) —
deployment.md,tls_and_proxy.md,security_hardening.md,observability.md,backup_and_recovery.md,upgrade.md,incident_response.md,troubleshooting.md,deployment_smoke.md.
Not here¶
- Release notes live in
docs/releases/, not in this directory. - Authored user docs live in
docs/user/— the combined handouts above are the only "published" copies of that content underdocs/pub/.
Drift detection¶
CI runs generate_combined_docs.py --check and generate_reference_docs.py --check on every PR; either failing means the underlying authored source changed without regenerating the artifact here.