docs: Update Some Router Docs by LadyBluenotes · Pull Request #5443 · TanStack/router

LadyBluenotes · 2025-10-10T19:06:01Z

Update Overview and Quick Start pages
Created an "Installation Guide" section for all install guides

Summary by CodeRabbit

Documentation
- Introduced a top-level "Installation Guides" grouping with framework-specific workflows; removed scattered installation items and the legacy How‑To; adjusted navigation.
- Added a comprehensive React manual setup and expanded React FAQ.
- Rewrote React and Solid quick-starts to emphasize CLI-driven setup and streamlined instructions.
- Updated file-based routing links and trimmed minor guidance.
- Removed obsolete React comparison and legacy installation pages.
- Updated cross‑links in Solid docs and Router CLI/Plugin READMEs.

coderabbitai · 2025-10-10T19:06:29Z

Walkthrough

Reorganizes documentation: creates a new top-level "Installation Guides" grouping framework-specific installation flows, moves/renames installation pages, removes obsolete React comparison and installation pages, adds a React manual setup guide and expanded FAQ, updates quick-starts for React and Solid, and fixes cross-links in READMEs and routing docs.

Changes

Cohort / File(s)	Summary of Changes
Docs navigation restructure `docs/router/config.json`	Consolidated installation/migration items into a new top-level Installation Guides; removed prior installation/how-to entries from framework routing sections; adjusted navigation structure and link targets.
React docs overhaul `docs/router/framework/react/comparison.md`, `docs/router/framework/react/installation.md`, `docs/router/framework/react/installation/manual.md`, `docs/router/framework/react/faq.md`, `docs/router/framework/react/quick-start.md`, `docs/router/framework/react/routing/file-based-routing.md`	Deleted old comparison and installation pages; added a new React manual setup guide; expanded React FAQ; rewrote Quick Start to emphasize installation/CLI-first flow; updated file-based routing links to the new installation paths and removed redundant installation entries.
Solid docs updates `docs/router/framework/solid/installation/manual.md`, `docs/router/framework/solid/quick-start.md`, `docs/router/framework/solid/routing/installation-with-router-cli.md`, `docs/router/framework/solid/routing/installation-with-vite.md`	Retitled/redirected manual installation to "Manual Setup"; revamped Solid quick start toward CLI-first installation; updated front-matter link targets for Router CLI and Vite installation pages.
Package README link fixes `packages/router-cli/README.md`, `packages/router-plugin/README.md`	Updated README/link references to point to the new installation path (`installation/with-router-cli`).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

docs: resolve invalid relative paths #5111 — Updates React installation/migration link targets; overlaps with this installation reorganization.
fix: various fixes #5215 — Adjusts README and package docs to point to installation/with-router-cli, matching link fixes here.
docs: Use named component in react quick-start #5061 — Modifies the React quick-start content; intersects with the quick-start rewrite in this PR.

Suggested reviewers

schiller-manuel
birkskyum
brenelz

Poem

In burrows of docs I tidily hop,
New paths I weave and old links I stop.
React and Solid, carrots in line,
CLI and guides now neatly combine.
Hop on, click through — the route is fine! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title “docs: Update Some Router Docs” is too generic to convey the substantial reorganization of installation paths, removal of outdated pages, and creation of a new Installation Guides section across multiple framework docs.	Consider revising the title to explicitly mention the main change, for example “docs: introduce centralized Installation Guides and reorganize router documentation,” to clearly reflect the scope of the changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

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 · 2025-10-10T19:06:36Z

View your CI Pipeline Execution ↗ for commit bd18cde

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

☁️ Nx Cloud last updated this comment at 2025-10-10 19:17:48 UTC

pkg-pr-new · 2025-10-10T19:07:41Z

More templates

@tanstack/arktype-adapter

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

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5443

@tanstack/eslint-plugin-router

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

@tanstack/history

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

@tanstack/nitro-v2-vite-plugin

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

@tanstack/react-router

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

@tanstack/react-router-devtools

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

@tanstack/react-router-ssr-query

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

@tanstack/react-start

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

@tanstack/react-start-client

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

@tanstack/react-start-server

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

@tanstack/router-cli

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

@tanstack/router-core

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

@tanstack/router-devtools

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

@tanstack/router-devtools-core

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

@tanstack/router-generator

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

@tanstack/router-plugin

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

@tanstack/router-ssr-query-core

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

@tanstack/router-utils

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

@tanstack/router-vite-plugin

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

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5443

@tanstack/solid-router

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

@tanstack/solid-router-devtools

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

@tanstack/solid-start

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

@tanstack/solid-start-client

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

@tanstack/solid-start-server

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

@tanstack/start-client-core

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

@tanstack/start-plugin-core

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

@tanstack/start-server-core

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

@tanstack/start-static-server-functions

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

@tanstack/start-storage-context

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

@tanstack/valibot-adapter

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

@tanstack/virtual-file-routes

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

@tanstack/zod-adapter

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

commit: bd18cde

coderabbitai

Actionable comments posted: 6

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d3cbb23 and d526af0.

📒 Files selected for processing (13)

docs/router/config.json (1 hunks)
docs/router/framework/react/comparison.md (0 hunks)
docs/router/framework/react/faq.md (1 hunks)
docs/router/framework/react/installation.md (0 hunks)
docs/router/framework/react/installation/manual.md (1 hunks)
docs/router/framework/react/quick-start.md (1 hunks)
docs/router/framework/react/routing/file-based-routing.md (1 hunks)
docs/router/framework/solid/installation/manual.md (1 hunks)
docs/router/framework/solid/quick-start.md (1 hunks)
docs/router/framework/solid/routing/installation-with-router-cli.md (1 hunks)
docs/router/framework/solid/routing/installation-with-vite.md (1 hunks)
packages/router-cli/README.md (1 hunks)
packages/router-plugin/README.md (1 hunks)

💤 Files with no reviewable changes (2)

docs/router/framework/react/comparison.md
docs/router/framework/react/installation.md

🧰 Additional context used

📓 Path-based instructions (4)

packages/{router-cli,router-generator,router-plugin,virtual-file-routes}/**

📄 CodeRabbit inference engine (AGENTS.md)

Keep CLI, generators, bundler plugins, and virtual file routing utilities in their dedicated tooling package directories

Files:

packages/router-cli/README.md
packages/router-plugin/README.md

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

docs/router/framework/react/routing/file-based-routing.md
docs/router/framework/react/installation/manual.md
docs/router/framework/react/quick-start.md
docs/router/framework/solid/routing/installation-with-router-cli.md
docs/router/framework/solid/routing/installation-with-vite.md
docs/router/framework/react/faq.md
docs/router/framework/solid/installation/manual.md
docs/router/framework/solid/quick-start.md

docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

docs/router/framework/react/routing/file-based-routing.md
docs/router/framework/react/installation/manual.md
docs/router/framework/react/quick-start.md
docs/router/framework/solid/routing/installation-with-router-cli.md
docs/router/framework/solid/routing/installation-with-vite.md
docs/router/config.json
docs/router/framework/react/faq.md
docs/router/framework/solid/installation/manual.md
docs/router/framework/solid/quick-start.md

packages/router-plugin/**

📄 CodeRabbit inference engine (AGENTS.md)

Use unplugin for universal bundler plugins in the router-plugin package

Files:

packages/router-plugin/README.md

🧠 Learnings (1)

📚 Learning: 2025-10-01T18:31:35.420Z

Learnt from: schiller-manuel
PR: TanStack/router#5330
File: e2e/react-start/custom-basepath/src/routeTree.gen.ts:58-61
Timestamp: 2025-10-01T18:31:35.420Z
Learning: Do not review files named `routeTree.gen.ts` in TanStack Router repositories, as these are autogenerated files that should not be manually modified.

Applied to files:

docs/router/framework/react/faq.md

🪛 markdownlint-cli2 (0.18.1)

packages/router-cli/README.md

5-5: Bare URL used

(MD034, no-bare-urls)

docs/router/framework/react/installation/manual.md

9-9: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

packages/router-plugin/README.md

13-13: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Test

docs/router/config.json

docs/router/framework/react/faq.md

docs/router/framework/react/installation/manual.md

docs/router/framework/react/quick-start.md

docs/router/framework/react/routing/file-based-routing.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* installation section * quick-start * update manual setup * fixed some links * fix links * Update docs/router/framework/react/faq.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

LadyBluenotes added 5 commits October 10, 2025 11:46

installation section

9a93052

quick-start

b4c963a

update manual setup

dea7fae

fixed some links

67d51b6

fix links

d526af0

github-actions bot added documentation Everything documentation related package: router-plugin package: router-cli labels Oct 10, 2025

coderabbitai bot reviewed Oct 10, 2025

View reviewed changes

LadyBluenotes and others added 2 commits October 10, 2025 12:11

Update docs/router/framework/react/faq.md

e888013

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Merge branch 'main' into router-overview

bd18cde

schiller-manuel changed the title ~~[Docs]: Update Some Router Docs~~ docs: Update Some Router Docs Oct 11, 2025

schiller-manuel merged commit faa8c71 into TanStack:main Oct 11, 2025
6 checks passed

This was referenced Oct 14, 2025

chore: bump @tanstack/config to v0.22.0 #5474

Merged

docs: add in llm support page #5479

Merged

LLM Script Fixes #5483

Merged

LadyBluenotes deleted the router-overview branch October 16, 2025 17:32

LadyBluenotes mentioned this pull request Oct 16, 2025

docs: fix router commands in quick-start #5499

Merged

This was referenced Oct 17, 2025

docs: Add comparison page back #5503

Merged

docs: fix solid installation guides #5519

Merged

display auth, query, static examples on tanstack.com #5563

Merged

coderabbitai bot mentioned this pull request Nov 12, 2025

docs(solid-router): quickstart example (code based) #5830

Merged

coderabbitai bot mentioned this pull request Nov 21, 2025

docs: format callouts to put content on new line #5927

Merged

coderabbitai bot mentioned this pull request Dec 21, 2025

Update framework comparison documentations for TanStack Router and TanStack Start #6170

Open

This was referenced Feb 1, 2026

docs: fix import path for routeTree in manual.md #6570

Closed

docs: replace deprecated create-tsrouter-app and create-start-app with @tanstack/cli create #6610

Open

coderabbitai bot mentioned this pull request Feb 14, 2026

docs(router): restructure docs to use the unified markdown syntax #6665

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Update Some Router Docs#5443

docs: Update Some Router Docs#5443
schiller-manuel merged 7 commits intoTanStack:mainfrom
LadyBluenotes:router-overview

LadyBluenotes commented Oct 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

nx-cloud bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 10, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Uh oh!

Conversation

LadyBluenotes commented Oct 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

nx-cloud bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

LadyBluenotes commented Oct 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 10, 2025 •

edited

Loading

nx-cloud bot commented Oct 10, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 10, 2025 •

edited

Loading