Uh oh!
There was an error while loading. Please reload this page.
docs: move the react-only guides to top-level and restrict in config.json - #6713
Conversation
📝 WalkthroughWalkthroughRelocated two React migration docs from framework-scoped paths into the generic Installation Guides and updated internal relative links across the affected migration pages to reflect the new directory structure. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
View your CI Pipeline Execution ↗ for commit 52de20a
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/router/installation/react-migrate-from-react-location.md`:
- Line 73: The link text "here" in the sentence "You can find the full list of
options for the `tsr.config.json` file
[here](../routing/file-based-routing.md)." is non-descriptive and triggers
markdownlint MD059; replace the link text with a descriptive label such as
"routing file-based routing options" or "tsr.config.json options" so the line
reads e.g. "You can find the full list of options for the `tsr.config.json` file
in the routing file-based routing options" linking to
../routing/file-based-routing.md; update that specific sentence in
react-migrate-from-react-location.md to satisfy accessibility and linting.
Uh oh!
There was an error while loading. Please reload this page.
restores the original filenames since the website redirects, for compatibility, expects that the names of the files remain the same.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/router/installation/migrate-from-react-location.md`:
- Line 18: Update the sentence in the migration guide to hyphenate the compound
adjective: change "non-routing related code" to "non-routing-related code" in
the introductory paragraph (the line referencing the React Location Basic
example and omitted styling/other non-routing-related code) so the compound
adjective preceding "code" is correctly hyphenated.
In `@docs/router/installation/migrate-from-react-router.md`:
- Line 10: Update the internal link in the checklist item that currently points
to "../how-to/install.md" so it follows the docs guideline of being relative to
the docs/ folder; replace the "../how-to/install.md" target used in the line
containing "Install Router - `npm i `@tanstack/react-router``" with
"./router/how-to/install.md".
---
Duplicate comments:
In `@docs/router/installation/migrate-from-react-location.md`:
- Line 73: Replace the non-descriptive link text "here" with a descriptive
phrase that explains the destination, e.g. change "You can find the full list of
options for the `tsr.config.json` file
[here](../routing/file-based-routing.md)." to something like "You can find the
full list of options for the `tsr.config.json` file in the file-based routing
documentation" and keep the existing target
(`../routing/file-based-routing.md`); update only the link text so it reads
"file-based routing documentation" or "tsr.config.json options" instead of
"here".
| ## Migration guide | ||
| In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routing related code will be omitted). |
There was a problem hiding this comment.
Hyphenate the compound adjective non-routing-related.
"non-routing related code" should be "non-routing-related code" — compound adjectives preceding a noun require hyphenation.
📝 Proposed fix
-In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routing related code will be omitted).+In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routing-related code will be omitted).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routingrelated code will be omitted). | |
| In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routing-related code will be omitted). |
🧰 Tools
🪛 LanguageTool
[grammar] ~18-~18: Use a hyphen to join words.
Context: ...l example (styling and other non-routing related code will be omitted). > [!TIP]...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/router/installation/migrate-from-react-location.md` at line 18, Update
the sentence in the migration guide to hyphenate the compound adjective: change
"non-routing related code" to "non-routing-related code" in the introductory
paragraph (the line referencing the React Location Basic example and omitted
styling/other non-routing-related code) so the compound adjective preceding
"code" is correctly hyphenated.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/router/installation/migrate-from-react-location.md`:
- Line 18: Change the phrase "non-routing related code" to the hyphenated
compound adjective "non-routing-related code" in the migration guide sentence
that starts "In this guide we'll go over the process..." so the compound
modifier correctly hyphenates before the noun; update the matching string in
docs/router/installation/migrate-from-react-location.md (look for that exact
sentence text).
Summary by CodeRabbit