Convert docs and contributor guides to reference links with scoped enforcement - #5225
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (49)
🚧 Files skipped from review as they are similar to previous changes (38)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthroughThe pull request converts inline Markdown links across repository documentation to reference-style links. It adds Remark-based validation, tests, npm commands, documentation guidance, and workflow coverage for Markdown files. ChangesReference Link Enforcement
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Sequence Diagram(s)sequenceDiagram
participant Author
participant Remark
participant LinkChecker
participant CI
Author->>Remark: submit Markdown with links
Remark-->>LinkChecker: report inline-link diagnostics
LinkChecker->>CI: return validation status
CI-->>Author: pass or fail documentation checks
Suggested reviewers: Merge Risk: ⚪ Minimal · up to The documentation change has no identified merge-blocking risk. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 3 files. (46 skipped: 46 unsupported.)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
arturcic
force-pushed
the
codex/5224-reference-links
branch
from
September 17, 2026 17:49
107e05c to
8ce9f7f
Compare
arturcic
changed the title
arturcic
force-pushed
the
codex/5224-reference-links
branch
from
September 17, 2026 17:54
8ce9f7f to
883bd9c
Compare
|
Contributor
|
Thank you @arturcic for your contribution! |
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.
Description
Convert inline Markdown links and images to reference-style definitions in
docs/, rootCONTRIBUTING.md, and rootBREAKING_CHANGES.md. Include the configuration documentation source and generated pages.Add a Remark-based checker and rule tests scoped to those documents. Keep npm commands and documentation CI integration, with workflow triggers for the two root documents. Document the scope and exceptions for autolinks, HTML, front matter, and literal Markdown examples.
Related Issue
Related to #5224. This PR covers a deliberately narrower documentation scope; the issue's repository-wide conversion and enforcement remain follow-up work.
Motivation and Context
Use consistent reference links in the selected documentation and prevent inline links from returning. Outside
docs/and the two root documents, onlypackage.jsonand.github/workflows/docs.ymlchange to support automated checks.How Has This Been Tested?
npm run test:links: 2 tests passed.npm run check:links: 62 Markdown files checked, 0 violations.actionlint .github/workflows/docs.yml: passed.The full documentation generation/build and rendered-link destination verification were not rerun during PR preparation. Link-style checks do not establish destination availability.
Checklist
Summary by CodeRabbit
Documentation
Validation