Skip to content

feat: Phase J J8 automated stale-doc detector -- backtick path scanner finds deleted src/scripts/schemas references in markdown, 63 tests - #908

Merged
cschanhniem merged 1 commit into
mainfrom
feat/j8-stale-doc-detector
Jul 10, 2026
Merged

cschanhniem merged 1 commit into
mainfrom
feat/j8-stale-doc-detector

Conversation

@cschanhniem

Copy link
Copy Markdown
Collaborator

Implements J8 from NEXT_100_PR_MAP: automated stale-doc detector.

What

  • stale_doc_detector.py: scans backtick-quoted file paths in markdown
  • check_stale_doc_references(docs_dir, repo_root) → StaleDocReport
  • _looks_like_repo_path(s): matches src/, tests/, scripts/, docs/, schemas/, decision_logs/ prefixes
  • _find_path_references(content, doc_path, repo_root): returns StaleDocReference per path found
  • format_stale_doc_report(report): shows stale entries with file:line → path
  • Complements check_doc_links.py (markdown syntax links); this handles prose backtick references
  • 63 tests across 5 test classes
  • BASELINE: 7843 → 7906

Why

Doc rot creates invisible friction. When docs say 'see src/foo.py' and that file was deleted, the next agent follows a dead pointer.

Disconfirming pass

  • Pure file-system inspection; no code execution
  • No existing modules modified
  • PATH_PREFIXES limited to known repo directories

…r finds deleted src/scripts/schemas references in markdown, 63 tests (#908)
@cschanhniem
cschanhniem force-pushed the feat/j8-stale-doc-detector branch from 595d17b to d52f679 Compare July 10, 2026 04:37
@cschanhniem
cschanhniem merged commit 3c56621 into main Jul 10, 2026
1 check failed
cschanhniem added a commit that referenced this pull request Jul 10, 2026
…r finds deleted src/scripts/schemas references in markdown, 63 tests (#908) (#909)

Co-authored-by: OpenCode <opencode@example.com>
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