Fix contributor docs links generated from .md references#1188
Open
rishabhk119 wants to merge 1 commit intoprocessing:mainfrom
Open
Fix contributor docs links generated from .md references#1188rishabhk119 wants to merge 1 commit intoprocessing:mainfrom
rishabhk119 wants to merge 1 commit intoprocessing:mainfrom
Conversation
Author
|
I’ve opened a PR to fix the broken .md links in the Contribute pages by updating rewriteRelativeMdLinks so links like ./contributor_guidelines.md#software-design-principles become /contribute/contributor_guidelines/#software-design-principles. This addresses some of the contributor docs links mentioned in the report. Thanks |
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.
This PR fixes some broken links in the Contribute pages that were still pointing to '.md' files (for eg.'./contributor_guidelines.md#software-design-principles'), which caused 404s on the built site.
What I changed:
-Updated
rewriteRelativeMdLinksinsrc/scripts/utils.tsso that relative.mdlinks are rewritten to/contribute/.../URLs, keeping the#anchorpart.-Absolute URLs and links that don’t end with
.mdstill go throughrewriteRelativeLinkand are unchanged.How I tested it:
-Ran `npm run dev.
-Opened the Contribute pages locally and checked that links like “software design principles” now go to '/contribute/contributor_guidelines/#software-design-principles' and no longer 404.