-
Notifications
You must be signed in to change notification settings - Fork 10
docs: use relative links in README.md instead of absolute GitHub blob URLs #399
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
Co-authored-by: ekraffmiller <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR converts absolute GitHub blob URLs in README.md to relative paths, ensuring that documentation links resolve to the current branch context rather than always pointing to main.
- Replaced 5 absolute GitHub blob URLs with relative paths
- Links now properly resolve to files in the same branch (e.g.,
develop, feature branches)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ekraffmiller
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good
ekraffmiller
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good
What this PR does / why we need it:
Replaces absolute GitHub blob links pointing to
mainbranch with relative paths so links resolve to the current branch context (e.g.,develop, feature branches).Changes:
https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/useCases.md→docs/useCases.mdhttps://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.md→docs/usage.mdhttps://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.md→CHANGELOG.mdhttps://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.md→CONTRIBUTING.mdhttps://github.com/IQSS/dataverse-client-javascript/blob/main/LICENSE→LICENSEWhich issue(s) this PR closes:
closes #400
Related Dataverse PRs:
Special notes for your reviewer:
Verify links work correctly when viewing README.md from different branches (e.g.,
develop,main).Suggestions on how to test this:
Navigate to this PR's branch on GitHub and click the documentation links in README.md to confirm they resolve to files in the same branch rather than
main.Is there a release notes or changelog update needed for this change?:
No - documentation-only change with no user-facing impact.
Additional documentation:
N/A
Original prompt
This pull request was created as a result of the following prompt from Copilot chat.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.