Skip to content

Navigation Menu

Sign in
Sign up

ci(docs): add a Markdown link checker so docs links don't rot #55

Open
Labels
documentationImprovements or additions to documentation enhancementNew feature or request good first issueGood for newcomers

Description

Background

The README, CONTRIBUTING.md, docs/, and the new ADRs link heavily to files and issues. A moved or renamed file silently breaks those links and there's nothing to catch it.

The task

Add a link-checking step to CI over the repo's Markdown so dead relative links fail the build.

  • Use an off-the-shelf action (e.g. lycheeverse/lychee-action) or a small script — your call, keep it simple.
  • Focus on internal/relative links and anchors first. External URLs are optional (they're flaky and can rate-limit); if you include them, make external failures non-blocking.
  • Pin any third-party action to a commit SHA with a trailing # vX comment — see the note at the top of .github/workflows/ci.yml.

Acceptance criteria

  • CI fails when a .md file links to a path that doesn't exist.
  • The check is green on dev today — fix any broken links you find as part of the PR.

Why this is a good first issue

Pure tooling/docs, no product code. Touches CI lightly and immediately pays off given how link-heavy our docs are.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation enhancementNew feature or request good first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      AltStyle によって変換されたページ (->オリジナル) /