docs: fix broken links#15114
Conversation
Two sets of internal links pointed at heading anchors that no longer exist: - upgrading/future.md linked to the middleware Data-mode setup section as `remix-run#2-typescript-augment-future-for-loaderaction-context`, but that heading is step 1 under "Quick Start (Data Mode)", so the correct anchor is `remix-run#1-typescript-augment-future-for-loaderaction-context`. - tutorials/address-book.md linked `[root-route]` and `[react-router-config]` to `../explanation/special-files#roottsx` and `#react-routerconfigts`. The Special Files page is now a stub whose content moved to the framework-conventions API pages, so neither anchor exists. Repointed both to `../api/framework-conventions/root.tsx` and `../api/framework-conventions/react-router.config.ts`, matching the links the Special Files page itself now uses. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Documentation link fixes updating outdated references to point to current documentation paths.
Changes:
- Update broken anchor link in middleware docs reference within
future.md - Update two broken links from
explanation/special-filesto newapi/framework-conventionspaths in the address book tutorial
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/upgrading/future.md | Corrects anchor fragment for the TypeScript Future augmentation section |
| docs/tutorials/address-book.md | Updates two reference links to new framework conventions doc locations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
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 |
|
Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳 |
|
Thanks! |
Two sets of internal links point at heading anchors that no longer exist:
upgrading/future.mdlinks to the middleware Data-mode setup section as#2-typescript-augment-future-for-loaderaction-context, but that heading is step 1under "Quick Start (Data Mode)" in
how-to/middleware.md, so the correct anchor is#1-typescript-augment-future-for-loaderaction-context.tutorials/address-book.mdlinks[root-route]and[react-router-config]to../explanation/special-files#roottsxand#react-routerconfigts. The Special Filespage is now a stub whose content has moved to the framework-conventions API pages, so
neither anchor exists. Repointed both to
../api/framework-conventions/root.tsxand../api/framework-conventions/react-router.config.ts, matching the links the SpecialFiles page itself now uses.
Docs-only change, branched from
mainper CONTRIBUTING. No change file needed.