Skip to content

DX-051: Add a link checker to the docs pipeline #563

Description

@IbrahimIjai

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

  • A broken internal link or anchor fails CI with file and line.
  • External failures never block a pull request.
  • The scheduled job opens exactly one issue per run, not one per link.
  • Runs clean against the full site at the time of merge.

Out of scope

  • Checking links in application code outside apps/docs.

Spec: docs/dx_1/001_docs_site.md §7 · Depends on: DX-050

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationtype:testing

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions