docs: use relative links in README.md instead of absolute GitHub blob URLs#399
Merged
ChengShi-1 merged 3 commits intodevelopfrom Jan 5, 2026
Merged
Conversation
Co-authored-by: ekraffmiller <675224+ekraffmiller@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README.md to use relative links
docs: use relative links in README.md instead of absolute GitHub blob URLs
Nov 14, 2025
Contributor
There was a problem hiding this comment.
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.
ChengShi-1
approved these changes
Jan 5, 2026
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.
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.