Skip to content

Comments

docs: move the react-only guides to top-level and restrict in config.json#6713

Merged
SeanCassiere merged 4 commits intomainfrom
router-react-only-docs
Feb 20, 2026
Merged

docs: move the react-only guides to top-level and restrict in config.json#6713
SeanCassiere merged 4 commits intomainfrom
router-react-only-docs

Conversation

@SeanCassiere
Copy link
Member

@SeanCassiere SeanCassiere commented Feb 20, 2026

Summary by CodeRabbit

  • Documentation
    • Moved two migration topics from framework-scoped locations into the general installation section for easier discovery.
    • Updated internal cross-links across migration guides to reflect the restructured documentation layout.
    • Cleaned up formatting and list indentation to improve readability and navigation within migration guides.

@github-actions github-actions bot added the documentation Everything documentation related label Feb 20, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 20, 2026

📝 Walkthrough

Walkthrough

Relocated 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

Cohort / File(s) Summary
Navigation Configuration
docs/router/config.json
Moved "Migrate from React Router" and "Migrate from React Location" navigation entries from framework/react/installation/... to installation/....
Migration Documentation
docs/router/installation/migrate-from-react-location.md, docs/router/installation/migrate-from-react-router.md
Adjusted internal relative links (reduced upward directory traversals, updated cross-reference paths) and minor indentation cleanup to align with the new file locations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰
I hopped through docs both wide and steep,
Moved two guides where paths are neat,
Trimmed the climbs from three to two,
Now readers hop straight through! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: moving React-specific migration guides to a top-level installation path and updating their configuration references in config.json.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch router-react-only-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Feb 20, 2026

View your CI Pipeline Execution ↗ for commit 52de20a

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2026-02-20 09:40:04 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 20, 2026

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@6713

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@6713

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@6713

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@6713

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@6713

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@6713

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@6713

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@6713

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@6713

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@6713

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@6713

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@6713

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@6713

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@6713

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@6713

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@6713

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@6713

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@6713

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@6713

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@6713

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@6713

@tanstack/solid-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-ssr-query@6713

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@6713

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@6713

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@6713

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@6713

@tanstack/start-fn-stubs

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-fn-stubs@6713

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@6713

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@6713

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@6713

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@6713

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@6713

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@6713

@tanstack/vue-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router@6713

@tanstack/vue-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router-devtools@6713

@tanstack/vue-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-router-ssr-query@6713

@tanstack/vue-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start@6713

@tanstack/vue-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start-client@6713

@tanstack/vue-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/vue-start-server@6713

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@6713

commit: 52de20a

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

SeanCassiere and others added 2 commits February 20, 2026 22:36
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>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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).
🧰 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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).

@SeanCassiere SeanCassiere merged commit 8bdf8d6 into main Feb 20, 2026
6 checks passed
@SeanCassiere SeanCassiere deleted the router-react-only-docs branch February 20, 2026 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant