docs: doc-claim drift detected on 2026-08-10 - #22
Open
NickCrew wants to merge 1 commit into
Open
Conversation
Automated audit of 12 doc files found 16 verified drift findings: 1 P0 (make -C Makefile not found), 11 P1 (nginx claim, force-include claim, DEMO_MODE default, education blueprint missing, broken links, missing test dirs/files, Flask-era test template, docs-drift recipe missing), 4 P2 (wheel version, coverage %, endpoint count inconsistency). Adds backlog/tasks/task-17 to track all findings with per-line citations.
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
1 participant
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
Automated doc-drift audit of the 12 active doc files found 16 verified drift findings across 8 files. This PR adds
backlog/tasks/task-17to track all findings with exact file:line citations and proposed fixes.Severity breakdown: 1×P0 · 11×P1 · 4×P2
Top findings by severity
P0 — user-facing command failure
README.md:243–246referencesmake -C apps/vuln-api test-unit/test-quick/test-vulnerability/test-smoke— noMakefileexists; the project usesjust.P1 — dev-doc errors (selection)
AGENTS.md:116— "nginx handles the proxy" in production Docker — no nginx; uvicorn serves via catch-all.docs/architecture.md:165—DEMO_MODEdefault shown astrue; code default is'full'(config.py:31).docs/architecture.md:88–116—education/blueprint missing from blueprint listing; it is imported and mounted inasgi.py.docs/architecture.md:151—force-includehatchling claim;pyproject.tomlhas no such entry.apps/vuln-api/README.md:7— broken linkdocs/API-DOCUMENTATION.md; file lives atAPI-DOCUMENTATION.md.apps/vuln-api/tests/README.md:69–76—tests/vulnerability/,tests/pytest.ini,tests/run_tests.shall listed but none exist.apps/vuln-api/tests/README.md:303–304— Flask-era test template (create_app('testing')+.test_client()); app is now Starlette.docs/endpoints-catalog.md:15— referencesjust docs-drift; no such recipe exists in any justfile.P2 — minor staleness
docs/developer-guide.md:335— wheel version 0.1.0;pyproject.tomlis at 0.1.5.docs/endpoints-catalog.md:15+600— same doc claims both 469 endpoints and 243 routes.apps/vuln-api/tests/README.md:212— coverage minimum 90%; justfile gate is 80%.Full findings with line-level citations are in backlog/tasks/task-17.
Generated by Claude Code