docs: make README bookmark internal links relative #1312
Merged
Conversation
This file contains 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
|
This comment was marked as outdated.
This comment was marked as outdated.
mschile
approved these changes
Nov 17, 2024
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.
Issue
Links in the README > Usage section, which refer to bookmarks in the same document, are using absolute URLs instead of relative ones.
This can cause the wrong information to be displayed when the README is accessed in a branch which is not the default
masterbranch.An example is https://github.com/cypress-io/github-action#custom-install-command
Change
Convert absolute URLs to relative ones in the README.md document, for links which refer to bookmarks in the README document itself.
For example, reduce
https://github.com/cypress-io/github-action#custom-install-commandto
#custom-install-commandVerification