Documentation
¶
Overview ¶
Command doclint checks local Markdown links and heading anchors across the repository without any network access. It exists so a broken in-repo doc link fails a targeted CI gate (see docs/engineering/ci.md) rather than rotting silently.
It deliberately checks only local references:
- relative file/directory links resolve to an existing path, and
- "#fragment" anchors (same-file or "file.md#fragment") resolve to a GitHub-style heading slug in the target Markdown file.
External links (http, https, mailto, protocol-relative) are skipped so the check stays fast and offline. Links inside fenced or inline code are ignored because they are documentation examples, not live references.
Click to show internal directories.
Click to hide internal directories.