Fix documentation link in README files#69
Open
becky-gilbert wants to merge 3 commits into
Open
Conversation
…emoteGitURL to root URL instead of undfined when it is empty (running from repo root)
…th; --readme-path -> --documentation-path
🦋 Changeset detectedLatest commit: 41582a1 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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
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.
Fixes #63
This PR changes the link used in the README.md file for the "See documentation" text. It includes the following changes:
/<package-root>/docs/<package-name>.md, rather than to the README file itself.treerather thanblobin full file URL; contains misplaced leading slash).--readme-pathflag to--documentation-path, for clarityExamples
Installing in a known repo (jsPsych contrib)
Old: points to README itself
New: points to the .md file in
/docsInstalling in an untracked (non-Git) directory or from the root of an unknown repo
Old: points back to README, and this is a broken link due to the leading slash, which makes it an absolute path from the domain root (https://github.com)
New: relative path to docs file
Installing in a subdirectory of an unknown repo
Old: points back to README and link is broken due to
/tree/New: points to docs file and works with
/blob/instead of/tree/Screenshots
New interactive console prompt for documentation file path, and the new default value (this was called inside an untracked directory).
p.s. Tests would be helpful... I would add tests that cover all of these cases if someone wants to add a test setup (👀 #4)