Internal cross-references resolve
Why it matters
Broken internal links are a reference-integrity defect: a README that points at docs/api.md after the file moved to docs/reference/api.md tells users the documentation is out of date and unreliable. Dead anchor links, missing image badges, and links to source files that were renamed in a refactor all accumulate after restructures. Each broken link is a dead end in the user's journey, and at scale they collectively destroy the navigability of the docs.
Severity rationale
Medium because broken links cause dead ends but most users find alternate paths.
Remediation
Run a link checker across all documentation files and fix every broken internal reference. Wire the check into CI so new breakage fails the build. Example:
npx markdown-link-check README.md
npx markdown-link-check 'docs/**/*.md'
Update stale paths or delete links whose targets are gone. For anchor links, verify the heading slug still matches after any rename.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the Developer Documentation Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
Taxons
History
- 2026-04-18·v1.0.0·Initial import from developer-documentation·automated