Files
compounding-intelligence/tests
Timmy_Burn_Worker ae675e72c2
Some checks failed
Test / pytest (pull_request) Failing after 11s
feat(doc-freshness): add checker to flag stale documentation references (Closes #104)
This adds scripts/doc_freshness.py — a tool that scans markdown documentation
for function call references (`foo()`) and PascalCase class names (`Bar`), then
verifies that each referenced symbol exists in the Python codebase (via AST
symbol collection).

- Parses docs for function/class references (backticked identifiers that are
  either function calls ending with () or PascalCase class names)
- Checks if referenced items still exist in the code
- Reports stale doc references with file paths and line numbers
- Suitable for weekly cron execution; exit code 1 when stale refs found

Includes tests in tests/test_doc_freshness.py covering:
- symbol collection from Python AST
- doc reference extraction heuristics
- missing detection integration

Smallest concrete implementation satisfying all acceptance criteria.
2026-04-26 11:09:43 -04:00
..