docs: fix broken links#15113
Conversation
The following relative-link reference definitions in the docs pointed at paths that do not exist, rendering as dead links on the docs site: - explanation/code-splitting.md: `../../start/framework/route-module` escaped the docs/ tree (resolved to <repo>/start/...). Corrected to `../start/framework/route-module`, matching the same target referenced from hot-module-replacement.md and styling.md. - explanation/index-query-param.md: `../api/data-routers/loader` and `../api/data-routers/action` had no corresponding pages. Repointed to `../start/data/route-object#loader` / `#action`, the canonical targets used elsewhere in the docs. - how-to/security.md: `../api/components/ServerRouter` -> ServerRouter lives at `../api/framework-routers/ServerRouter`. - start/framework/installation.md and start/framework/actions.md: removed two orphaned reference definitions (`[manual_usage]`, `[data]`) that were never used and pointed at non-existent pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Hi @morgan-coded, Welcome, and thank you for contributing to React Router! Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once. You may review the CLA and sign it by adding your name to contributors.yml. Once the CLA is signed, the If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run. Thanks! - The Remix team |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates documentation reference links and cleans up unused link definitions to keep the docs consistent and prevent broken/outdated references.
Changes:
- Removed unused reference-link definitions from framework docs pages.
- Updated several reference links to point to current documentation locations.
- Corrected an incorrect relative path in the code-splitting explanation doc.
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/start/framework/installation.md | Removes an unused reference-link definition from the page footer. |
| docs/start/framework/actions.md | Removes an unused reference-link definition from the page footer. |
| docs/how-to/security.md | Updates the ServerRouter reference link to the new docs location. |
| docs/explanation/index-query-param.md | Updates loader/action reference links to point at the route-object docs anchors. |
| docs/explanation/code-splitting.md | Fixes the relative path for the route-module reference link. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
|
Thanks! |
Several relative-link reference definitions in the docs point at paths that
don't exist, so they render as dead links on the docs site:
explanation/code-splitting.md:[route-module]used../../start/framework/route-module,which escapes the
docs/tree (resolves to<repo>/start/...). Corrected to../start/framework/route-module, matching the same target already referenced fromhot-module-replacement.mdandstyling.md.explanation/index-query-param.md:[loader]and[action]pointed at../api/data-routers/loader/action, which have no corresponding pages. Repointedto
../start/data/route-object#loader/#action, the canonical targets usedelsewhere in the docs.
how-to/security.md:[serverrouter]pointed at../api/components/ServerRouter,but
ServerRouterlives at../api/framework-routers/ServerRouter.start/framework/installation.mdandstart/framework/actions.md: removed twoorphaned reference definitions (
[manual_usage],[data]) that were never used andpointed at non-existent pages.
Docs-only change, branched from
mainper CONTRIBUTING. No change file needed(no user-facing API impact).