Skip to content

Conversation

@LadyBluenotes
Copy link
Contributor

@LadyBluenotes LadyBluenotes commented Oct 10, 2025

In Router:

  • Updated the Overview & Quick Start pages
  • Added an Installation Guides section (moved some installation guides from "Guides" to this section)
  • Created "Manual setup" from info in Quick Start

In Start:

  • Updated Overview page
  • Added a Guides section to shorten the "Getting Started" section

Summary by CodeRabbit

  • Documentation

    • Major docs reorganization with a new Installation Guides section for React and Solid (manual setup, toolchain options).
    • Revamped Quick Start and Overview pages for Router and Start; added React FAQ content and a “Migrate from Next.js” guide.
    • Consolidated guide paths under /guide/, streamlined content, and removed outdated How-To and comparison pages.
    • Updated SSR docs to use the new default render handler name and clarified relative navigation behavior.
  • Chores

    • Updated example projects to latest patch versions of devtools, router plugin, and React Start.

LadyBluenotes and others added 25 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>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Reorganizes documentation navigation and content for Router and Start across React and Solid, consolidating installation guides, updating paths to /guide/, and pruning extensive “how-to” pages. Introduces minor API name updates in docs (SSR render handler, SPA mode). Updates many example package.jsons with TanStack dependency patch bumps.

Changes

Cohort / File(s) Summary
Router docs navigation restructure
docs/router/config.json
Consolidates installation into new top-level “Installation Guides”; removes scattered install/migration/how-to entries from Getting Started, Routing, and How-To.
Router React “How-To” removals
docs/router/framework/react/how-to/*, .../drafts/*
Deletes numerous React how-to and draft guides (auth, testing, SSR setup, search params, UI integrations, env vars, RBAC, migration).
Router React installation docs
docs/router/framework/react/installation/*, .../installation.md, .../installation/manual.md, .../installation/with-esbuild.md
Adds a new Manual installation guide; removes old umbrella installation page; normalizes ESbuild title casing.
Router React guides/content updates
docs/router/framework/react/faq.md, .../guide/navigation.md, .../guide/ssr.md, .../overview.md, .../quick-start.md, .../comparison.md
Expands FAQ; adds relative navigation note; updates SSR docs to use defaultRenderHandler; rewrites overview and quick start; removes comparison page.
Router Solid minor updates
docs/router/framework/solid/installation/manual.md, .../overview.md, .../quick-start.md
Adjusts titles/mappings for Solid manual setup and quick start; tweaks overview replace directives.
Start docs navigation overhaul
docs/start/config.json
Adds React “Migrate from Next.js”; introduces Solid framework block; moves many routes under framework//guide/; removes Tutorials section; updates Tailwind entry path.
Start React guide updates
docs/start/framework/react/guide/server-functions.md, .../guide/spa-mode.md, .../overview.md, .../quick-start.md
Fixes internal link; renames API usage from TanStackStart to tanstackStart; rewrites overview and quick start content/flow.
Start Solid guide mappings/stubs
docs/start/framework/solid/guide/*, .../overview.md, .../environment-functions.md
Points Solid guides to React guide sources with replace mappings; updates replacement rules; standardizes references across multiple guide topics.
Examples dependency bumps
examples/react/*/package.json, examples/react/*/*/package.json
Bumps @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

Poem

I hop through docs, reshaping trails,
Installation burrows, neatly in pails.
Guides now grouped, the map runs true,
SPA spells updated, SSR anew.
Examples nibble fresh versions, yum!
Tap-tap my paws—onward we drum.
Route on, friends—thump-thump! 🐇✨

✨ 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 51da7fb and 13a2f5c.

⛔ 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/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)
  • examples/react/start-counter/package.json (1 hunks)
  • examples/react/start-i18n-paraglide/package.json (1 hunks)
  • examples/react/start-large/package.json (1 hunks)
  • examples/react/start-material-ui/package.json (1 hunks)
  • examples/react/start-streaming-data-from-server-functions/package.json (1 hunks)
⛔ Files not processed due to max files limit (36)
  • 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