Repository navigation
docs: rebuild the docs set with generated reference and a CI check - #227
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rebuilds the documentation as a MkDocs Material site, checked against the code. No Python changes.
scripts/docs/check.shruns the generators, renders the diagrams and does a strict site build. The newDocsworkflow runs it on every PR.lawful_basisattachments but does not create, validate or enforce them. They make no compliance claim.prod_mgt/andREADME_REDIS_CACHING.mdmoved todocs/archive/.Files outside
docs/andscripts/docs/:.github/workflows/docs.yml,CLAUDE.md,README.md,common/README_CORE.md,mkdocs.ymland the link READMEs underconserver/links/.Before merging
mainand the site is not published.Known gaps
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.Testing
scripts/docs/check.shpasses locally on this commit: generators, 14 diagram renders and the strict MkDocs build.--no-verifybecause 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