fix: convert absolute /docs links to relative .mdx repo-wide#2549
Open
ElliotFriend wants to merge 1 commit into
Open
fix: convert absolute /docs links to relative .mdx repo-wide#2549ElliotFriend wants to merge 1 commit into
ElliotFriend wants to merge 1 commit into
Conversation
Sweeps the remaining absolute /docs/... links (7 occurrences across 5 files) to relative ../path/file.mdx links per the repo convention. Relative links with the file extension are validated at build time by onBrokenMarkdownLinks; absolute route links are not. Tier 1 Orgs page is handled separately in stellar#2546. CONTRIBUTING.md is left untouched: it is excluded from the docs build and its /docs link is an intentional illustrative example. Part of stellar#2547 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes sub-task 1 of #2547 by converting remaining absolute internal /docs/... links to file-relative ../path/file.mdx links across the docs, aligning with the repo’s relative-link convention and enabling stronger build-time link validation.
Changes:
- Replaced absolute
/docs/...links with relative.mdxlinks in 5 docs files. - Preserved existing anchors during conversion (e.g.,
#stellarexpert,#base-reserves-and-subentries). - Updated links to point at concrete MDX targets that exist in-repo (including index
README.mdxpages where applicable).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tools/lab/transaction-dashboard.mdx | Converts Indexers + Block Explorers links to relative .mdx targets (anchor preserved). |
| docs/validators/README.mdx | Converts Tier 1 Orgs link to ./tier-1-orgs.mdx. |
| docs/validators/admin-guide/publishing-history-archives.mdx | Converts Tier 1 Orgs link to relative ../tier-1-orgs.mdx. |
| docs/validators/admin-guide/configuring.mdx | Converts Tier 1 + Publishing History Archives links to relative .mdx targets. |
| docs/validators/admin-guide/prerequisites.mdx | Converts Tier 1, reserve requirements (anchor preserved), and Publishing History Archives links to relative .mdx targets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Preview is available here: |
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.
Sub-task 1 of #2547 — the repo-wide sweep. Converts the remaining absolute
/docs/...internal links to relative../path/file.mdxlinks, matching the convention already used across the repo.Changes
7 link occurrences across 5 files:
docs/tools/lab/transaction-dashboard.mdx#stellarexpertanchor preserved)docs/validators/README.mdxdocs/validators/admin-guide/publishing-history-archives.mdxdocs/validators/admin-guide/configuring.mdxdocs/validators/admin-guide/prerequisites.mdx#base-reserves-and-subentriesanchor preserved), Publishing History ArchivesDeliberately excluded
docs/validators/tier-1-orgs.mdx— handled in its own PR fix: use relative .mdx links on Tier 1 Orgs page #2548 (fixes Link to MDX files on Tier 1 Orgs page #2546).docs/platforms/anchor-platform/CONTRIBUTING.md— its/docs/...link is an intentional illustrative example, and the file isexcluded from the docs build (docusaurus.config.ts line 143), so its links are never processed. Note: that file's "cross-plugin-instance" guidance appears stale — there is now a single docs plugin instance (routeBasePath: /docs), and relative links work across the wholedocs/tree. Worth a separate cleanup pass, out of scope here.Verification
grep -rn '](/docs' docs/returns only the two excluded files above#stellarexpert,#base-reserves-and-subentries) verified against their headingsprettier -c(matches CIci:mdx) passesNote for sub-task 2 (the automated check)
The CI grep gate must exclude
**/CONTRIBUTING.md— otherwise the deliberate example there is a false positive. Suggested:grep -rn '](/docs' docs/ --include='*.mdx' | grep -v CONTRIBUTING, or scope the gate to built pages only.Part of #2547
🤖 Generated with Claude Code