Context
Broken internal links are the most common documentation defect and the easiest
to prevent. External links break too, but on someone else's schedule — which is
why they must not be able to fail a pull request.
Scope
bun run --cwd apps/docs check:links validating every internal link and
heading anchor against the page index, plus image and asset paths.
- Anchor validation checks the target heading actually exists on the target page.
- Internal checking runs on every pull request in CI.
- External link checking is a separate scheduled workflow that opens an issue on
failure rather than blocking merges, with a configurable ignore list.
- Report groups failures by source file with line numbers.
Acceptance criteria
Out of scope
- Checking links in application code outside
apps/docs.
Spec: docs/dx_1/001_docs_site.md §7 · Depends on: DX-050
Context
Broken internal links are the most common documentation defect and the easiest
to prevent. External links break too, but on someone else's schedule — which is
why they must not be able to fail a pull request.
Scope
bun run --cwd apps/docs check:linksvalidating every internal link andheading anchor against the page index, plus image and asset paths.
failure rather than blocking merges, with a configurable ignore list.
Acceptance criteria
Out of scope
apps/docs.Spec:
docs/dx_1/001_docs_site.md§7 · Depends on: DX-050