Skip to content

Conversation

LadyBluenotes
Copy link
Contributor

@LadyBluenotes LadyBluenotes commented Oct 10, 2025

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

Summary by CodeRabbit

  • Documentation
    • Consolidated installation content into a new Installation Guides section (React and Solid), and rewrote Quick Starts toward a CLI-first flow.
    • Expanded React FAQ with reasons to choose TanStack Router and key feature deep-dives; clarified relative navigation edge cases.
    • Updated SSR docs to reference defaultRenderHandler; streamlined overviews and comparisons; removed legacy comparison/how-to pages and tutorials.
    • Reorganized Start docs paths (…/guide/…), added Solid framework entries, and added “Migrate from Next.js” (React).
  • Chores
    • Bumped @tanstack/react-router-devtools, @tanstack/router-plugin, and @tanstack/react-start versions across example projects.

LadyBluenotes and others added 27 commits October 8, 2025 11:40
…se TanStack Start doesn't have a "Guides" section yet (TanStack#5399)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
…TanStack#5424)

* add extra context

* ci: apply automated fixes

* add code rabbit suggestion

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Docs were heavily reorganized: navigation configs updated, many React “How-To” pages removed, new consolidated Installation Guides added, multiple React/Solid docs revised (FAQs, quick-starts, SSR API rename in docs, overviews), Start docs paths normalized under guide/, and examples bumped TanStack dependency patch versions.

Changes

Cohort / File(s) Summary
Router Docs Navigation Restructure
docs/router/config.json
Reorganized nav: removed scattered install/migrate/how-to nodes; added top-level “Installation Guides” for React/Solid; pruned redundant items.
React Router Docs Removals (How-To, Comparisons, Install)
docs/router/framework/react/how-to/*, docs/router/framework/react/how-to/drafts/*, docs/router/framework/react/installation.md, docs/router/framework/react/comparison.md
Deleted comprehensive How-To guides (auth, SSR, testing, search params, integrations, migrations) and comparison/installation pages.
React Router Docs Additions/Edits
docs/router/framework/react/faq.md, .../guide/navigation.md, .../guide/ssr.md, .../installation/manual.md, .../installation/with-esbuild.md, .../overview.md, .../quick-start.md
Added/expanded FAQ; added Manual Setup; updated navigation notes; renamed SSR helper in examples (defaultRenderHandler); retitled ESbuild page; condensed overview; shifted quick-start to CLI-first.
Solid Router Docs Alignment
docs/router/framework/solid/installation/manual.md, .../overview.md, .../quick-start.md
Retitled to “Manual Setup”; adjusted refs/replacements; quick-start rewritten to CLI-focused flow.
Start Docs Config Restructure
docs/start/config.json
Added React “Migrate from Next.js”; added Solid framework block; moved many items under framework/.../guide/...; removed Tutorials section.
Start React Docs Edits
docs/start/framework/react/build-from-scratch.md, .../getting-started.md, .../guide/authentication.md, .../guide/middleware.md, .../guide/routing.md, .../guide/server-functions.md, .../guide/spa-mode.md, .../overview.md, .../quick-start.md
Updated links/paths; simplified text; adjusted middleware/server-functions references; renamed Vite plugin usage to tanstackStart; expanded overview and quick-start.
Start Solid Docs Edits
docs/start/framework/solid/environment-functions.md, docs/start/framework/solid/guide/*, docs/start/framework/solid/overview.md, docs/start/framework/solid/quick-start.md
Moved/added Solid guide refs; updated replace mappings (React→SolidJS); removed old env-functions doc; streamlined overview; expanded quick-start.
Examples: Dependency Version Bumps
examples/react/*/package.json, examples/react/router-monorepo-*/packages/*/package.json
Bumped @tanstack/react-router-devtools, @tanstack/router-plugin, and @tanstack/react-start to 1.132.51 across many examples; no code changes.

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • schiller-manuel
  • brenelz
  • birkskyum

Poem

I hopped through docs, a tidy spree,
Old trails pruned, new paths set free.
Install maps bloom, guides align,
Solid and React, now neatly in line.
Patch-bumped carrots for examples bright—
Thump-thump! Our routes read right. 🥕✨

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent 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 8751c3a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (107)
  • docs/router/config.json (1 hunks)
  • docs/router/framework/react/comparison.md (0 hunks)
  • docs/router/framework/react/faq.md (2 hunks)
  • docs/router/framework/react/guide/navigation.md (1 hunks)
  • docs/router/framework/react/guide/ssr.md (3 hunks)
  • docs/router/framework/react/how-to/README.md (0 hunks)
  • docs/router/framework/react/how-to/arrays-objects-dates-search-params.md (0 hunks)
  • docs/router/framework/react/how-to/debug-router-issues.md (0 hunks)
  • docs/router/framework/react/how-to/deploy-to-production.md (0 hunks)
  • docs/router/framework/react/how-to/drafts/README.md (0 hunks)
  • docs/router/framework/react/how-to/drafts/build-search-filtering-systems.draft.md (0 hunks)
  • docs/router/framework/react/how-to/drafts/optimize-search-param-performance.draft.md (0 hunks)
  • docs/router/framework/react/how-to/drafts/search-params-in-forms.draft.md (0 hunks)
  • docs/router/framework/react/how-to/install.md (0 hunks)
  • docs/router/framework/react/how-to/integrate-chakra-ui.md (0 hunks)
  • docs/router/framework/react/how-to/integrate-framer-motion.md (0 hunks)
  • docs/router/framework/react/how-to/integrate-material-ui.md (0 hunks)
  • docs/router/framework/react/how-to/integrate-shadcn-ui.md (0 hunks)
  • docs/router/framework/react/how-to/migrate-from-react-router.md (0 hunks)
  • docs/router/framework/react/how-to/navigate-with-search-params.md (0 hunks)
  • docs/router/framework/react/how-to/setup-auth-providers.md (0 hunks)
  • docs/router/framework/react/how-to/setup-authentication.md (0 hunks)
  • docs/router/framework/react/how-to/setup-basic-search-params.md (0 hunks)
  • docs/router/framework/react/how-to/setup-rbac.md (0 hunks)
  • docs/router/framework/react/how-to/setup-ssr.md (0 hunks)
  • docs/router/framework/react/how-to/setup-testing.md (0 hunks)
  • docs/router/framework/react/how-to/share-search-params-across-routes.md (0 hunks)
  • docs/router/framework/react/how-to/test-file-based-routing.md (0 hunks)
  • docs/router/framework/react/how-to/use-environment-variables.md (0 hunks)
  • docs/router/framework/react/how-to/validate-search-params.md (0 hunks)
  • docs/router/framework/react/installation.md (0 hunks)
  • docs/router/framework/react/installation/manual.md (1 hunks)
  • docs/router/framework/react/installation/with-esbuild.md (1 hunks)
  • docs/router/framework/react/overview.md (1 hunks)
  • docs/router/framework/react/quick-start.md (1 hunks)
  • docs/router/framework/solid/installation/manual.md (1 hunks)
  • docs/router/framework/solid/overview.md (1 hunks)
  • docs/router/framework/solid/quick-start.md (1 hunks)
  • docs/start/config.json (1 hunks)
  • docs/start/framework/react/build-from-scratch.md (2 hunks)
  • docs/start/framework/react/getting-started.md (1 hunks)
  • docs/start/framework/react/guide/authentication.md (1 hunks)
  • docs/start/framework/react/guide/middleware.md (1 hunks)
  • docs/start/framework/react/guide/routing.md (1 hunks)
  • docs/start/framework/react/guide/server-functions.md (1 hunks)
  • docs/start/framework/react/guide/spa-mode.md (2 hunks)
  • docs/start/framework/react/overview.md (2 hunks)
  • docs/start/framework/react/quick-start.md (3 hunks)
  • docs/start/framework/solid/environment-functions.md (0 hunks)
  • docs/start/framework/solid/guide/authentication-overview.md (1 hunks)
  • docs/start/framework/solid/guide/databases.md (1 hunks)
  • docs/start/framework/solid/guide/environment-functions.md (1 hunks)
  • docs/start/framework/solid/guide/middleware.md (1 hunks)
  • docs/start/framework/solid/guide/path-aliases.md (1 hunks)
  • docs/start/framework/solid/guide/reading-writing-file.md (1 hunks)
  • docs/start/framework/solid/guide/server-entry-point.md (1 hunks)
  • docs/start/framework/solid/guide/server-functions.md (1 hunks)
  • docs/start/framework/solid/guide/spa-mode.md (1 hunks)
  • docs/start/framework/solid/guide/static-server-functions.md (1 hunks)
  • docs/start/framework/solid/overview.md (1 hunks)
  • docs/start/framework/solid/quick-start.md (2 hunks)
  • examples/react/authenticated-routes-firebase/package.json (1 hunks)
  • examples/react/authenticated-routes/package.json (1 hunks)
  • examples/react/basic-default-search-params/package.json (1 hunks)
  • examples/react/basic-devtools-panel/package.json (1 hunks)
  • examples/react/basic-file-based/package.json (1 hunks)
  • examples/react/basic-non-nested-devtools/package.json (1 hunks)
  • examples/react/basic-react-query-file-based/package.json (1 hunks)
  • examples/react/basic-react-query/package.json (1 hunks)
  • examples/react/basic-ssr-file-based/package.json (2 hunks)
  • examples/react/basic-ssr-streaming-file-based/package.json (2 hunks)
  • examples/react/basic-virtual-file-based/package.json (1 hunks)
  • examples/react/basic-virtual-inside-file-based/package.json (1 hunks)
  • examples/react/basic/package.json (1 hunks)
  • examples/react/deferred-data/package.json (1 hunks)
  • examples/react/i18n-paraglide/package.json (1 hunks)
  • examples/react/kitchen-sink-file-based/package.json (1 hunks)
  • examples/react/kitchen-sink-react-query-file-based/package.json (1 hunks)
  • examples/react/kitchen-sink-react-query/package.json (1 hunks)
  • examples/react/kitchen-sink/package.json (1 hunks)
  • examples/react/large-file-based/package.json (1 hunks)
  • examples/react/location-masking/package.json (1 hunks)
  • examples/react/navigation-blocking/package.json (1 hunks)
  • examples/react/quickstart-esbuild-file-based/package.json (1 hunks)
  • examples/react/quickstart-file-based/package.json (1 hunks)
  • examples/react/quickstart-rspack-file-based/package.json (2 hunks)
  • examples/react/quickstart-webpack-file-based/package.json (1 hunks)
  • examples/react/quickstart/package.json (1 hunks)
  • examples/react/router-monorepo-react-query/package.json (1 hunks)
  • examples/react/router-monorepo-react-query/packages/app/package.json (1 hunks)
  • examples/react/router-monorepo-react-query/packages/router/package.json (1 hunks)
  • examples/react/router-monorepo-simple-lazy/package.json (1 hunks)
  • examples/react/router-monorepo-simple-lazy/packages/app/package.json (1 hunks)
  • examples/react/router-monorepo-simple-lazy/packages/router/package.json (1 hunks)
  • examples/react/router-monorepo-simple/package.json (1 hunks)
  • examples/react/router-monorepo-simple/packages/app/package.json (1 hunks)
  • examples/react/router-monorepo-simple/packages/router/package.json (1 hunks)
  • examples/react/scroll-restoration/package.json (1 hunks)
  • examples/react/search-validator-adapters/package.json (1 hunks)
  • examples/react/start-bare/package.json (1 hunks)
  • examples/react/start-basic-auth/package.json (1 hunks)
  • examples/react/start-basic-cloudflare/package.json (1 hunks)
  • examples/react/start-basic-react-query/package.json (1 hunks)
  • examples/react/start-basic-static/package.json (1 hunks)
  • examples/react/start-basic/package.json (1 hunks)
  • examples/react/start-bun/package.json (1 hunks)
  • examples/react/start-convex-trellaux/package.json (1 hunks)
⛔ Files not processed due to max files limit (41)
  • examples/react/start-counter/package.json
  • examples/react/start-i18n-paraglide/package.json
  • examples/react/start-large/package.json
  • examples/react/start-material-ui/package.json
  • examples/react/start-streaming-data-from-server-functions/package.json
  • examples/react/start-supabase-basic/package.json
  • examples/react/start-tailwind-v4/package.json
  • examples/react/start-trellaux/package.json
  • examples/react/start-workos/package.json
  • examples/react/view-transitions/package.json
  • examples/react/with-framer-motion/package.json
  • examples/react/with-trpc-react-query/package.json
  • examples/react/with-trpc/package.json
  • examples/solid/basic-devtools-panel/package.json
  • examples/solid/basic-file-based/package.json
  • examples/solid/basic-non-nested-devtools/package.json
  • examples/solid/basic-solid-query-file-based/package.json
  • examples/solid/basic-solid-query/package.json
  • examples/solid/basic-ssr-streaming-file-based/package.json
  • examples/solid/basic/package.json
  • examples/solid/kitchen-sink-file-based/package.json
  • examples/solid/quickstart-file-based/package.json
  • examples/solid/start-bare/package.json
  • examples/solid/start-basic-static/package.json
  • examples/solid/start-basic/package.json
  • packages/directive-functions-plugin/package.json
  • packages/react-router-devtools/package.json
  • packages/react-start/package.json
  • packages/router-cli/package.json
  • packages/router-devtools-core/package.json
  • packages/router-devtools-core/vite.config.ts
  • packages/router-devtools/package.json
  • packages/router-generator/package.json
  • packages/router-plugin/package.json
  • packages/router-utils/package.json
  • packages/router-utils/src/copy-files-plugin.ts
  • packages/router-vite-plugin/package.json
  • packages/server-functions-plugin/package.json
  • packages/solid-router-devtools/package.json
  • packages/solid-start/package.json
  • packages/start-plugin-core/package.json

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment