Add internal link checker for documentation#8178
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an internal Markdown link checker and integrates it into CI to prevent introducing new broken internal links while tolerating existing known issues via a baseline.
Changes:
- Added a zero-dependency Node.js link-checker (
bin/check-links.js) with optional baseline filtering and baseline generation. - Integrated link checking into the documentation validation GitHub Actions workflow.
- Added contributor documentation for running the link checker locally and committed a baseline of existing issues.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/en/contributing/documentation.md | Documents how to run the new link checker and adds it to the local pre-flight command list. |
| bin/check-links.js | Implements internal link validation, globbing, anchor resolution, and baseline filtering/generation. |
| .github/workflows/docs-validation.yml | Adds a new CI job to run the link checker (baseline-enabled) on changed markdown files. |
| .github/linkchecker-baseline.json | Stores the catalog of known broken links for baseline filtering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
LordSimal
approved these changes
Jan 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds automated validation of internal markdown links with baseline support for existing issues.
Changes
Link Checker Script (
bin/check-links.js)"docs/**/*.md"CI Integration (
.github/workflows/docs-validation.yml)Baseline (
.github/linkchecker-baseline.json)--baselineflagUsage