Skip to content

docs: doc-claim drift detected on 2026-08-17 - #23

Open
NickCrew wants to merge 1 commit into
mainfrom
docs/drift-2026-08-17
Open

docs: doc-claim drift detected on 2026-08-17#23
NickCrew wants to merge 1 commit into
mainfrom
docs/drift-2026-08-17

Conversation

@NickCrew

Copy link
Copy Markdown
Collaborator

Summary

Automated doc-drift audit against the 12-file active doc set found 17 confirmed drift findings across 8 files. This PR adds backlog/tasks/task-17 - Doc-drift-detected-2026-08-17.md to track remediation.

  • 11 P1 dev-doc errors (broken commands, wrong defaults, stale file references, Flask-era test template still present)
  • 6 P2 minor staleness items (version number, internal count inconsistency, missing helper claim)
  • 0 P0 user-facing factual errors

Top findings by severity

File Finding Severity
docs/architecture.md DEMO_MODE default listed as true; code default is full P1
docs/architecture.md education/ blueprint missing from directory listing P1
README.md DEMO_MODE default says strict; app/config.py defaults to full P1
README.md make -C apps/vuln-api test-unit — no Makefile in apps/vuln-api/ P1
AGENTS.md "nginx handles the proxy" in Docker — Dockerfile.prod runs uvicorn directly P1
apps/vuln-api/README.md Link docs/API-DOCUMENTATION.md resolves to non-existent path P1
apps/vuln-api/AGENTS.md make test-coverage — no Makefile; use just test-coverage P1
apps/vuln-api/tests/README.md tests/vulnerability/ directory referenced but doesn't exist P1
apps/vuln-api/tests/README.md Flask-style test template (self.app.test_client()) in Starlette project P1
apps/vuln-api/tests/README.md Coverage minimum listed as 90%; justfile enforces 80% P1
docs/developer-guide.md Wheel filename shows 0.1.0; pyproject.toml version is 0.1.5 P2
docs/endpoints-catalog.md "243 Total Routes" vs "469 unique endpoints" in same file P2

Full finding list with exact file:line anchors and proposed fixes is in backlog/tasks/task-17 - Doc-drift-detected-2026-08-17.md.


Generated by Claude Code

17 confirmed doc-claim drift findings across 8 of the 12 audited
files — 11 P1 dev-doc errors and 6 P2 staleness items. Adds
backlog/tasks/task-17 to track remediation.

Copy link
Copy Markdown
Collaborator Author

CI status note: both failing checks are pre-existing failures on main (last 3 CI runs on main all show failure) — not caused by this PR's Markdown-only change.

  • Test Backendextractions/setup-just@v2 returns "no release for just matching version specifier" (action setup failure, unrelated to diff)
  • Test vuln-api-hp (Rust) — GitHub rate-limited the dtolnay/rust-toolchain download with HTTP 429 (transient network issue)

Neither failure touches the backlog/tasks/ path this PR touches. Safe to merge once the base-branch CI issues are resolved.


Generated by Claude Code

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