docs: clarify link-fixer should not change link extension style - #398
Open
VinuRithika75 wants to merge 1 commit into
Open
docs: clarify link-fixer should not change link extension style#398VinuRithika75 wants to merge 1 commit into
VinuRithika75 wants to merge 1 commit into
Conversation
✅ Deploy Preview for contribute-cncf-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
What
Adds a rule to the link-fixer workflow instructing it to preserve a link's
existing extension style (
.mdor no extension) when fixing broken links —it should only correct what's actually wrong (path, typo, domain), not
change the link style itself.
Why
This closes #302. The original concern was that the live site strips
.mdfrom links, so the bot shouldn't add it. That assumption was actually
disproven in the #266 discussion — Docusaurus resolves both
.mdandextension-less links fine, and
.mdlinks are already used throughout thedocs (e.g.
docs/community/tags/index.md). So the real gap wasn't "alwaysstrip .md" — it was that the workflow had no explicit rule stopping it from
changing a link's style at all, which is an unrelated edit under Rule 4.
This adds that guardrail.
Contributes to #302