Fix broken internal documentation links and GitHub repository URLs#712
Fix broken internal documentation links and GitHub repository URLs#712wvanderp wants to merge 1 commit intoopen-rpc:masterfrom
Conversation
- Add /docs prefix to all internal documentation links in MDX files - Fix docsRepositoryBase URL to include /tree/master for proper GitHub integration - Remove unavailable /webinar/ link from learn.mdx - Ensure all navigation links point to correct routes
|
@wvanderp is attempting to deploy a commit to the open-rpc Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
Updates the documentation site’s internal navigation to reflect that docs are hosted under /docs, and adjusts the GitHub repository base used for “Edit this page” links.
Changes:
- Updated internal MDX links to use
/docs/*routes. - Removed an unavailable
/webinar/link from the Learn page. - Updated
docsRepositoryBaseto include a branch path segment.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/beginners.mdx | Updates internal links to /docs/* targets. |
| src/content/learn.mdx | Updates internal links to /docs/* and removes the webinar link. |
| src/content/developers.mdx | Updates internal link to /docs/beginners. |
| src/content/getting-started.mdx | Updates “Next Steps” internal links to /docs/*. |
| src/content/use.mdx | Updates internal link to /docs/developers. |
| src/app/layout.tsx | Updates docsRepositoryBase to include /tree/master. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Started using OpenRPC [open-rpc.org/use](/docs/use) | ||
| - Learn more about OpenRPC and its technology [open-rpc.org/learn](/docs/learn) | ||
| - Build on OpenRPC Tooling [open-rpc.org/developers](/docs/developers) |
There was a problem hiding this comment.
These bullets link to /docs/... but the displayed URLs are still open-rpc.org/use, open-rpc.org/learn, etc. If the canonical paths are now under /docs, update the visible URLs (or use descriptive link text) so readers don’t copy/paste a non-existent route.
| - Started using OpenRPC [open-rpc.org/use](/docs/use) | |
| - Learn more about OpenRPC and its technology [open-rpc.org/learn](/docs/learn) | |
| - Build on OpenRPC Tooling [open-rpc.org/developers](/docs/developers) | |
| - Start using OpenRPC with the [Use OpenRPC guide](/docs/use) | |
| - Learn more about OpenRPC and its technology in the [OpenRPC overview](/docs/learn) | |
| - Build on OpenRPC tooling with the [Developer docs](/docs/developers) |
| #### OpenRPC Tooling Foundations | ||
|
|
||
| Need a more basic non-technical primer first? Check out [open-rpc.org/beginners](/beginners). | ||
| Need a more basic non-technical primer first? Check out [open-rpc.org/beginners](/docs/beginners). |
There was a problem hiding this comment.
The destination now points to /docs/beginners, but the link text still shows open-rpc.org/beginners. If /beginners isn’t a valid route on this site, update the displayed URL (e.g., open-rpc.org/docs/beginners) or switch to descriptive link text to avoid confusion.
| Need a more basic non-technical primer first? Check out [open-rpc.org/beginners](/docs/beginners). | |
| Need a more basic non-technical primer first? Check out the [OpenRPC beginners guide](/docs/beginners). |
| # Learn about OpenRPC | ||
|
|
||
| **Welcome to [open-rpc.org/learn](/learn/), a set of resources to help you learn more about OpenRPC.** This page includes technical **and** non-technical articles, guides, and resources. If you’re totally new to OpenRPC, [we suggest you start here](/beginners/). | ||
| **Welcome to [open-rpc.org/learn](/docs/learn), a set of resources to help you learn more about OpenRPC.** This page includes technical **and** non-technical articles, guides, and resources. If you're totally new to OpenRPC, [we suggest you start here](/docs/beginners). |
There was a problem hiding this comment.
The link target was updated to /docs/learn, but the link text still shows open-rpc.org/learn. If docs are served under /docs (as configured in next.config.ts), consider updating the displayed URL to open-rpc.org/docs/learn (or using descriptive text) so readers don’t copy a path that may 404.
| **Welcome to [open-rpc.org/learn](/docs/learn), a set of resources to help you learn more about OpenRPC.** This page includes technical **and** non-technical articles, guides, and resources. If you're totally new to OpenRPC, [we suggest you start here](/docs/beginners). | |
| **Welcome to [open-rpc.org/docs/learn](/docs/learn), a set of resources to help you learn more about OpenRPC.** This page includes technical **and** non-technical articles, guides, and resources. If you're totally new to OpenRPC, [we suggest you start here](/docs/beginners). |
1 participant
Summary
I found some dead links on your site.
This is a very naive fix for these links.
Hope you can eighter accept it as is or improve it.
Changes Made
/docsprefix to all internal documentation links in MDX files (beginners, learn, developers, getting-started, use)docsRepositoryBasein layout.tsx to include/tree/masterfor proper GitHub "Edit this page" functionality/webinar/link from learn.mdxFiles Modified
src/content/beginners.mdxsrc/content/learn.mdxsrc/content/developers.mdxsrc/content/getting-started.mdxsrc/content/use.mdxsrc/app/layout.tsx