Skip to content
Source
Sign inSign up
TanStack/router

docs: Move files to Guides section #5441

MergedLadyBluenotes(GitHub profile, opens in a new tab)merged 2 commits intomain fromrefs/pull/5441/headmerged by schiller-manuel(GitHub profile, opens in a new tab)

Moved files not relevant to getting started to a Guides section and updated relevant links.

Summary by CodeRabbit

  • New Features

    • Added “Migrate from Next.js” to React Getting Started.
    • Introduced Solid getting started section (Overview, Getting Started, Quick Start, Build from Scratch).
  • Documentation

    • Standardized React and Solid guide URLs under /guide/ and updated internal links (routing, server functions, hosting, etc.).
    • Moved Tailwind CSS Integration to Solid guides; updated framework-specific references.
    • Removed the Tutorials section.
    • Refreshed navigation to reflect new structure; fixed broken/old links.
    1. Walkthrough

      Documentation navigation and internal links were reorganized: a new Solid framework section was added, React and Solid guide paths were standardized under guide/, a Next.js migration page was introduced to React Getting Started, and the Tutorials section was removed. Multiple docs updated internal references to the new guide structure.

      Changes

      Cohort / File(s)Summary of Changes
      Docs navigation config
      docs/start/config.json
      Added Solid framework section; added React “Migrate from Next.js”; moved many React/Solid guide paths under guide/; repointed Tailwind link; removed Tutorials section.
      React getting started & scaffolding docs
      docs/start/framework/react/build-from-scratch.md, docs/start/framework/react/getting-started.md, docs/start/framework/react/quick-start.md
      Updated internal links to new guide paths (routing, hosting, migration).
      React migration guide overhaul
      docs/start/framework/react/migrate-from-next-js.md
      Extensive content updates to reflect TanStack Start patterns: Route-based APIs, loader usage, Link changes, server functions/routes examples, image/font examples; updated cross-refs to guide/ paths.
      Solid getting started & scaffolding docs
      docs/start/framework/solid/build-from-scratch.md, docs/start/framework/solid/getting-started.md, docs/start/framework/solid/quick-start.md
      Updated routing/hosting links to guide/ paths; adjusted introductory notes accordingly.
      Solid guide frontmatter refs/mappings
      docs/start/framework/solid/guide/authentication-overview.md, .../databases.md, .../environment-functions.md, .../middleware.md, .../path-aliases.md, .../reading-writing-file.md, .../server-entry-point.md, .../server-functions.md, .../spa-mode.md, .../static-server-functions.md
      Pointed refs to React guide pages under guide/; updated replace mappings (React→SolidJS, @tanstack/react-start→@tanstack/solid-start) where applicable.
      Solid env fns (non-guide) cleanup
      docs/start/framework/solid/environment-functions.md
      Removed cross-ref and replacement rule; no content logic changes.

      Estimated code review effort

      🎯 3 (Moderate) | ⏱️ ~25 minutes

      • TanStack/router#5211 — Also updates the React migrate-from-next-js guide with Route/loader/server examples.
      • TanStack/router#5326 — Parallel migration doc changes converting Next.js patterns to TanStack Start APIs.
      • TanStack/router#5347 — Adjusts Solid Start documentation and guide paths similar to this restructure.

      Suggested reviewers

      • schiller-manuel
      • brenelz
      • birkskyum

      Poem

      A hop and a skip through docs we go, Paths now guide where streams may flow. React to Solid, the routes realign, Tutorials vanish—clean, concise design. I thump with joy, my work complete— Follow the guide, where links now meet. 🥕✨

      Pre-merge checks and finishing touches

      ✅ Passed checks (3 passed)
      Check nameStatusExplanation
      Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
      Docstring Coverage✅ PassedNo functions found in the changes. Docstring coverage check skipped.
      Title Check✅ PassedThe title succinctly describes the principal change of reorganizing documentation into a Guides section, which aligns with the pull request’s content of moving files and updating links accordingly. It is concise, clear, and free of unnecessary detail.
      ✨ 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.
    2. View your CI Pipeline Execution ↗ for commit e1c8bf3c0576f5523f1be4cd83afc0c429701df2

      CommandStatusDurationResult
      nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded<1sView ↗
      nx run-many --target=build --exclude=examples/*...✅ Succeeded2sView ↗

      ☁️ Nx Cloud last updated this comment at 2025-10-10 18:38:23 UTC

    3. More templates

      @tanstack/arktype-adapter

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

      @tanstack/directive-functions-plugin

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

      @tanstack/eslint-plugin-router

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

      @tanstack/history

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

      @tanstack/nitro-v2-vite-plugin

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

      @tanstack/react-router

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

      @tanstack/react-router-devtools

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

      @tanstack/react-router-ssr-query

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

      @tanstack/react-start

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

      @tanstack/react-start-client

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

      @tanstack/react-start-server

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

      @tanstack/router-cli

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

      @tanstack/router-core

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

      @tanstack/router-devtools

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

      @tanstack/router-devtools-core

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

      @tanstack/router-generator

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

      @tanstack/router-plugin

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

      @tanstack/router-ssr-query-core

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

      @tanstack/router-utils

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

      @tanstack/router-vite-plugin

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

      @tanstack/server-functions-plugin

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

      @tanstack/solid-router

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

      @tanstack/solid-router-devtools

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

      @tanstack/solid-start

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

      @tanstack/solid-start-client

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

      @tanstack/solid-start-server

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

      @tanstack/start-client-core

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

      @tanstack/start-plugin-core

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

      @tanstack/start-server-core

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

      @tanstack/start-static-server-functions

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

      @tanstack/start-storage-context

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

      @tanstack/valibot-adapter

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

      @tanstack/virtual-file-routes

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

      @tanstack/zod-adapter

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

      commit: e1c8bf3

    4. Actionable comments posted: 4

      📜 Review details

      Configuration used: CodeRabbit UI

      Review profile: CHILL

      Plan: Pro

      📥 Commits

      Reviewing files that changed from the base of the PR and between 51da7fb8429b1d7cd4374253b4df7a01d6c1ac22 and e1c8bf3c0576f5523f1be4cd83afc0c429701df2.

      📒 Files selected for processing (19)
      • docs/start/config.json (1 hunks)
      • docs/start/framework/react/build-from-scratch.md (2 hunks)
      • docs/start/framework/react/getting-started.md (2 hunks)
      • docs/start/framework/react/migrate-from-next-js.md (2 hunks)
      • docs/start/framework/react/quick-start.md (2 hunks)
      • docs/start/framework/solid/build-from-scratch.md (2 hunks)
      • docs/start/framework/solid/environment-functions.md (0 hunks)
      • docs/start/framework/solid/getting-started.md (1 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/quick-start.md (2 hunks)
      💤 Files with no reviewable changes (1)
      • docs/start/framework/solid/environment-functions.md
      🧰 Additional context used
      📓 Path-based instructions (2)
      docs/**/*.{md,mdx}

      📄 CodeRabbit inference engine (AGENTS.md)

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

      Files:

      • docs/start/framework/react/quick-start.md
      • docs/start/framework/solid/build-from-scratch.md
      • docs/start/framework/solid/guide/authentication-overview.md
      • docs/start/framework/react/getting-started.md
      • docs/start/framework/solid/guide/environment-functions.md
      • docs/start/framework/react/build-from-scratch.md
      • docs/start/framework/solid/guide/spa-mode.md
      • docs/start/framework/solid/quick-start.md
      • docs/start/framework/solid/guide/middleware.md
      • docs/start/framework/solid/getting-started.md
      • docs/start/framework/solid/guide/path-aliases.md
      • docs/start/framework/solid/guide/server-entry-point.md
      • docs/start/framework/solid/guide/reading-writing-file.md
      • docs/start/framework/solid/guide/server-functions.md
      • docs/start/framework/solid/guide/static-server-functions.md
      • docs/start/framework/solid/guide/databases.md
      • docs/start/framework/react/migrate-from-next-js.md
      docs/{router,start}/**

      📄 CodeRabbit inference engine (AGENTS.md)

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

      Files:

      • docs/start/framework/react/quick-start.md
      • docs/start/framework/solid/build-from-scratch.md
      • docs/start/framework/solid/guide/authentication-overview.md
      • docs/start/framework/react/getting-started.md
      • docs/start/framework/solid/guide/environment-functions.md
      • docs/start/framework/react/build-from-scratch.md
      • docs/start/framework/solid/guide/spa-mode.md
      • docs/start/framework/solid/quick-start.md
      • docs/start/framework/solid/guide/middleware.md
      • docs/start/framework/solid/getting-started.md
      • docs/start/framework/solid/guide/path-aliases.md
      • docs/start/framework/solid/guide/server-entry-point.md
      • docs/start/framework/solid/guide/reading-writing-file.md
      • docs/start/framework/solid/guide/server-functions.md
      • docs/start/framework/solid/guide/static-server-functions.md
      • docs/start/config.json
      • docs/start/framework/solid/guide/databases.md
      • docs/start/framework/react/migrate-from-next-js.md
      ⏰ 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: Preview
      🔇 Additional comments (1)
      docs/start/framework/solid/guide/databases.md (1)

      2-4: Link update aligns with new guide structure. The reference now targets the React guide’s moved databases page, and the replacement map correctly switches to Solid-specific naming.

      Resolvedby LadyBluenotes(GitHub profile, opens in a new tab)
      Resolvedby LadyBluenotes(GitHub profile, opens in a new tab)
      Resolvedby LadyBluenotes(GitHub profile, opens in a new tab)
      Resolvedby LadyBluenotes(GitHub profile, opens in a new tab)
    5. @ttsirkia good question - i believe it wasnt originally included but i don't see why it shouldn't be. @schiller-manuel was this guide supposed to be published?

    6. @LadyBluenotes i think we shouldnt put everyhing in the sidebar as it might get too cluttered? needs some work on clustering etc

    7. @schiller-manuel yeah it is getting busy. might be worth a rethink on how to make it less so

Sign in to join this conversation.