Skip to content

docs: rebuild the docs set with generated reference and a CI check - #227

Merged
howethomas merged 1 commit into
mainfrom
docs/vconic-docs-set
Nov 4, 2026
Merged

howethomas merged 1 commit into
mainfrom
docs/vconic-docs-set

Conversation

@howethomas

@howethomas howethomas commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Rebuilds the documentation as a MkDocs Material site, checked against the code. No Python changes.

  • Reference: a page for every link, storage adapter and tracer. Env var, port, route and metric pages are generated from code.
  • Drift check: scripts/docs/check.sh runs the generators, renders the diagrams and does a strict site build. The new Docs workflow runs it on every PR.
  • Visuals: 14 Mermaid diagrams, each with a sources file naming the code it describes, and 4 motion scenes.
  • Concepts and guides: new pages, including lawful basis and editions, plus a contributing guide.
  • Edition boundary: the docs state that this repo carries and preserves lawful_basis attachments but does not create, validate or enforce them. They make no compliance claim.
  • Cleanup: Poetry instructions replaced with uv. prod_mgt/ and README_REDIS_CACHING.md moved to docs/archive/.

Files outside docs/ and scripts/docs/: .github/workflows/docs.yml, CLAUDE.md, README.md, common/README_CORE.md, mkdocs.yml and the link READMEs under conserver/links/.

Before merging

  • Set Settings > Pages > Source to GitHub Actions. Until then the deploy job fails on main and the site is not published.

Known gaps

  • 8 TODO(verify) markers remain in live pages, for items that need a running service or measured figures, such as sizing tables, Prometheus names and Dataverse filters.
  • The Compose stack, published images and vendor APIs were not exercised.
  • Where the audit found code that behaves differently from what a reader would expect, the docs describe what the code does today. Those problems are tracked separately.

Testing

  • scripts/docs/check.sh passes locally on this commit: generators, 14 diagram renders and the strict MkDocs build.
  • The commit used --no-verify because the secret scan flagged 9 lines. All 9 were reviewed and are false positives: placeholder values in examples and one code fragment.

🤖 Generated with Claude Code

Replace the scattered docs with a MkDocs Material site organised into
start, concepts, guides, reference, operations and visuals.

- Add reference pages for every link, storage adapter and tracer
- Generate the env var, port, route and metric pages from code, and
  fail CI through scripts/docs/check.sh when they drift
- Add 14 Mermaid diagrams and 4 motion scenes, each diagram with a
  sources file naming the code it describes
- State the edition boundary: this repo carries and preserves
  lawful_basis attachments but does not create or enforce them
- Replace Poetry instructions with uv
- Move prod_mgt/ and README_REDIS_CACHING.md to docs/archive/
- Add a docs workflow that checks PRs and deploys from main

No Python changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@howethomas
howethomas merged commit f9db3f2 into main Nov 4, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant