You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
scripts/check_docs.py has no test coverage of its own #97
scripts/check_docs.py's entire job is catching documentation drift mechanically (placeholder-table sync,
README/Step 1:1 sync, local link resolution), but the script itself has no test suite. A future edit that
silently breaks one of its three checks (e.g. a regex tweak that stops matching anything) would read as
"0 errors -> pass" in CI, giving false confidence.
Suggested fix
Add a couple of fixture-based smoke tests: a known-good doc set that should exit 0, and 2-3 known-broken doc
sets (missing placeholder row, README/Step count mismatch, a dangling relative link) that should each exit
non-zero with a clear message. Doesn't need a test framework — stdlib unittest keeps the script's
zero-dependency property.
Provenance
Found during a public-readiness review ahead of this repo's planned public flip, 2026-08-02.
Activity
Fold in nice-to-have readiness items: tests, TOC, pinned CI, scripts …
Document install step; add ISSUE_TEMPLATE to doc sources table (#102)