fix: correct edit links for GitHub - #96
Open
davidjb wants to merge 1 commit into
Open
Conversation
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.
Summary
This follows on from #95, adding the required missing
/into the edit links for GitHub. That previous PR attempted to change the link to pointing at/blob, which is the "show" view of the file, but not the edit link.As seen on a page like https://react-svgr.com/docs/jest/, the edit link is currently broken, pointing at:
https://github.com/gregberge/svgredit/main/website/pages/docs/jest.mdx
But it should be:
https://github.com/gregberge/svgr/edit/main/website/pages/docs/jest.mdx
(addition of a slash separator before
/edit).Per https://github.com/gregberge/smooth-doc/blob/main/website/pages/docs/options.mdx#githubrepositoryurl, the option should not have a trailing slash, so this is all the fix that's required.
Test plan
Clicking on the 2nd link above takes you to the edit UI for that page to confirm the fix.