Docs: use relative links for internal docs references - #253
Open
HussainAther wants to merge 1 commit into
Open
Conversation
Member
|
Thank you for the PR. I have added this to the "review backlog from during sprints" item of the Communication & Documentation Team roadmap Google Doc to ensure this won't be forgotten about. |
HussainAther
force-pushed
the
docs/relative-internal-docs-links
branch
from
June 21, 2026 16:52
2f5a089 to
f4b799e
Compare
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 updates several documentation pages to use relative links when referencing other pages within the Hubs documentation, instead of absolute
https://docs.hubsfoundation.org/...URLs.The affected files are limited to:
docs/dev-client-networking.mddocs/dev-contributing.mddocs/how-to-backup-your-Hubs-instance.mddocs/set-up-SMTP-email-service.mdWhy?
Docusaurus correctly resolves both absolute and relative links today.
This change is not required for correctness, but helps improve consistency and maintainability by:
This aligns with the longer-term goal of normalizing link formatting across
hubs-docs.Limitations
Alternatives considered
This PR intentionally keeps scope small and focused to a few files.
Open questions