Fix CLI README command links#2226
Open
Eudes-Crabe wants to merge 1 commit into
Open
Conversation
|
This PR is stale because it has been open for more than 14 days with no activity. Remove stale label or comment or this will be closed in 14 days. |
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
Fixes the relative links in
packages/cli/README.mdso they work when the README is rendered from the@percy/clipackage context on npm.The current links point to paths such as
./packages/cli-exec#readme, which are valid from the repository root README but become broken frompackages/cli/README.md. This updates them to sibling-package paths such as../cli-exec#readme.The same correction is applied to the advanced package links in that README.
Related issue
Fixes #1152
Testing
Manual verification: inspected the README links and confirmed they now resolve relative to
packages/cli/README.mdinstead of incorrectly nesting underpackages/cli/packages/....