docs: Move files to Guides section #5441
main fromrefs/pull/5441/head·merged 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
github-actions[bot](GitHub profile, opens in a new tab) added labelsdocumentation
View your CI Pipeline Execution ↗ for commit e1c8bf3c0576f5523f1be4cd83afc0c429701df2
Command Status Duration Result nx affected --targets=test:eslint,test:unit,tes...✅ Succeeded <1s View ↗ nx run-many --target=build --exclude=examples/*...✅ Succeeded 2s View ↗
☁️ Nx Cloud last updated this comment at
2025-10-10 18:38:23UTCMore templates
- tanstack-router-solid-example-basic
- tanstack-router-solid-example-basic-devtools-panel
- tanstack-router-solid-example-basic-file-based
- tanstack-router-solid-example-basic-non-nested-devtools
- tanstack-router-solid-example-basic-solid-query
- tanstack-router-solid-example-basic-solid-query-file-based
- tanstack-router-solid-example-basic-ssr-streaming-file-based
- tanstack-router-solid-example-kitchen-sink-file-based
- tanstack-router-solid-example-quickstart-file-based
- tanstack-solid-start-example-bare
- tanstack-solid-start-example-basic
- tanstack-solid-start-example-basic-static
- tanstack-router-react-example-authenticated-routes
- tanstack-router-react-example-authenticated-routes-firebase
- tanstack-router-react-example-basic
- tanstack-router-react-example-basic-default-search-params
- tanstack-router-react-example-basic-devtools-panel
- tanstack-router-react-example-basic-file-based
- tanstack-router-react-example-basic-non-nested-devtools
- tanstack-router-react-example-react-query
- tanstack-router-react-example-basic-react-query-file-based
- tanstack-router-react-example-basic-ssr-file-based
- tanstack-router-react-example-basic-ssr-streaming-file-based
- tanstack-router-react-example-basic-virtual-file-based
- tanstack-router-react-example-basic-virtual-inside-file-based
- tanstack-router-react-example-deferred-data
- tanstack-router-i18n-paraglide
- tanstack-router-react-example-kitchen-sink
- tanstack-router-react-example-kitchen-sink-file-based
- tanstack-router-react-example-kitchen-sink-react-query
- tanstack-router-react-example-kitchen-sink-react-query-file-based
- tanstack-router-react-example-large-file-based
- tanstack-router-react-example-location-masking
- tanstack-router-react-example-navigation-blocking
- tanstack-router-react-example-quickstart
- tanstack-router-react-example-quickstart-esbuild-file-based
- tanstack-router-react-example-quickstart-file-based
- tanstack-router-react-example-quickstart-rspack-file-based
- tanstack-router-react-example-quickstart-webpack-file-based
- router-monorepo-react-query
- router-mono-simple
- router-mono-simple-lazy
- tanstack-router-react-example-scroll-restoration
- tanstack-search-validator-adapters
- tanstack-start-example-bare
- tanstack-start-example-basic
- tanstack-start-example-basic-auth
- tanstack-start-example-basic-cloudflare
- tanstack-start-example-basic-react-query
- tanstack-start-example-basic-static
- tanstack-start-bun-hosting
- tanstack-start-example-convex-trellaux
- tanstack-start-example-counter
- tanstack-start-i18n-paraglide
- tanstack-start-example-large
- tanstack-start-example-material-ui
- tanstack-start-streaming-data-from-server-functions
- tanstack-start-example-supabase-basic
- tanstack-start-tailwind-v4
- tanstack-start-example-trellaux
- tanstack-start-example-workos
- tanstack-router-react-example-view-transitions
- tanstack-router-react-example-with-framer-motion
- tanstack-router-react-example-with-trpc
- tanstack-router-react-example-with-trpc-react-query
@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@5441commit:
e1c8bf3Actionable 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.mddocs/start/framework/solid/build-from-scratch.mddocs/start/framework/solid/guide/authentication-overview.mddocs/start/framework/react/getting-started.mddocs/start/framework/solid/guide/environment-functions.mddocs/start/framework/react/build-from-scratch.mddocs/start/framework/solid/guide/spa-mode.mddocs/start/framework/solid/quick-start.mddocs/start/framework/solid/guide/middleware.mddocs/start/framework/solid/getting-started.mddocs/start/framework/solid/guide/path-aliases.mddocs/start/framework/solid/guide/server-entry-point.mddocs/start/framework/solid/guide/reading-writing-file.mddocs/start/framework/solid/guide/server-functions.mddocs/start/framework/solid/guide/static-server-functions.mddocs/start/framework/solid/guide/databases.mddocs/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.mddocs/start/framework/solid/build-from-scratch.mddocs/start/framework/solid/guide/authentication-overview.mddocs/start/framework/react/getting-started.mddocs/start/framework/solid/guide/environment-functions.mddocs/start/framework/react/build-from-scratch.mddocs/start/framework/solid/guide/spa-mode.mddocs/start/framework/solid/quick-start.mddocs/start/framework/solid/guide/middleware.mddocs/start/framework/solid/getting-started.mddocs/start/framework/solid/guide/path-aliases.mddocs/start/framework/solid/guide/server-entry-point.mddocs/start/framework/solid/guide/reading-writing-file.mddocs/start/framework/solid/guide/server-functions.mddocs/start/framework/solid/guide/static-server-functions.mddocs/start/config.jsondocs/start/framework/solid/guide/databases.mddocs/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.@@ -103,17 +138,14 @@138+ "to": "framework/react/guide/databases"103139 },104140 {105141 "label": "Observability",106- "to": "framework/react/observability"142+ "to": "framework/react/guide/observability"107143 },108144 {109145 "label": "Path Aliases",110- "to": "framework/react/path-aliases"146+ "to": "framework/react/guide/path-aliases"111147 },112148 {113149 "label": "Tailwind CSS Integration",114- "to": "framework/react/tailwind-integration"115- },116- {117- "label": "Migrate from Next.js",118- "to": "framework/react/migrate-from-next-js"150+ "to": "framework/solid/guide/tailwind-integration"119151 }⚠️ Potential issue | 🟠 Major
React Tailwind guide points to Solid docs
The React guides navigation now routes “Tailwind CSS Integration” to
framework/solid/guide/tailwind-integration, so React users land on the Solid guide. Please update this entry to the React guide path (e.g.,framework/react/guide/tailwind-integration) to keep the frameworks separated.🤖 Prompt for AI Agents
In docs/start/config.json around lines 149 to 151, the navigation entry "Tailwind CSS Integration" incorrectly points to the Solid guide; change its "to" value from "framework/solid/guide/tailwind-integration" to the correct React path "framework/react/guide/tailwind-integration" so React users are routed to the React Tailwind guide.@@ -1,2 +1,2 @@11 ---2-ref: docs/start/framework/react/authentication-overview.md2+ref: docs/start/framework/react/guide/authentication-overview.md🛠️ Refactor suggestion | 🟠 Major
Make
refpath relative todocs/.Guidelines require internal doc links to stay relative to
docs/. Please drop the leadingdocs/and update the path accordingly.Apply this diff:
-ref: docs/start/framework/react/guide/authentication-overview.md +ref: ./start/framework/react/guide/authentication-overview.md📝 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.
ref: ./start/framework/react/guide/authentication-overview.md🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/authentication-overview.md around line 2, the ref path currently includes a leading "docs/"; update the reference to be relative to the docs/ root by removing the leading "docs/" so it points to start/framework/react/guide/authentication-overview.md instead, ensuring internal doc links remain relative to the docs/ directory.@@ -0,0 +1,4 @@1+---2+ref: docs/start/framework/react/guide/environment-functions.md3+replace: { 'react': 'solid' }4+---⚠️ Potential issue | 🟠 Major
Include Solid replacements for package and framework names
This page might still mention
@tanstack/react-startand “React” because the replacement map only covers lowercasereact. Add the package and capitalized framework substitutions so the rendered Solid guide doesn’t leak React terminology.--- -ref: docs/start/framework/react/guide/environment-functions.md -replace: { 'react': 'solid' } +ref: docs/start/framework/react/guide/environment-functions.md +replace: + { + '@tanstack/react-start': '@tanstack/solid-start', + 'React': 'SolidJS', + 'react': 'solid' + } ---📝 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.
--- ref: docs/start/framework/react/guide/environment-functions.md replace: { '@tanstack/react-start': '@tanstack/solid-start', 'React': 'SolidJS', 'react': 'solid' } ---🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/environment-functions.md around lines 2 to 4, the replacement map only covers lowercase "react" so the rendered Solid guide still references @tanstack/react-start and "React"; update the replacement map to also replace the package name and the capitalized framework name by adding entries that map "@tanstack/react-start" -> "@tanstack/solid-start" and "React" -> "Solid" (in addition to the existing "react" -> "solid") so both package and capitalized framework terminology are correctly substituted.@@ -1,2 +1,2 @@11 ---2-ref: docs/start/framework/react/reading-writing-file.md2+ref: docs/start/framework/react/guide/reading-writing-file.md🛠️ Refactor suggestion | 🟠 Major
Fix ref path to follow docs link convention.
Per the docs guideline we should keep internal refs relative to
docs/. Please update therefvalue to./start/framework/react/guide/reading-writing-file.md(no leadingdocs/).🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/reading-writing-file.md around line 2, the ref value currently points to docs/start/framework/react/guide/reading-writing-file.md which violates the docs link convention; update the ref to use a path relative to docs by changing it to ./start/framework/react/guide/reading-writing-file.md (remove the leading docs/).schiller-manuel(GitHub profile, opens in a new tab) changed the title
This page https://tanstack.com/start/latest/docs/framework/react/guide/streaming-data-from-server-functions is not visible in the menu and can only be found by following a link in page https://tanstack.com/start/latest/docs/framework/react/guide/server-functions Is this the expected behavior?
@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?
@LadyBluenotes i think we shouldnt put everyhing in the sidebar as it might get too cluttered? needs some work on clustering etc
@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.
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#
docs/start/config.jsondocs/start/framework/react/build-from-scratch.md,docs/start/framework/react/getting-started.md,docs/start/framework/react/quick-start.mddocs/start/framework/react/migrate-from-next-js.mddocs/start/framework/solid/build-from-scratch.md,docs/start/framework/solid/getting-started.md,docs/start/framework/solid/quick-start.mddocs/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.mddocs/start/framework/solid/environment-functions.mdEstimated code review effort#
🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs#
Suggested reviewers#
Poem#
Pre-merge checks and finishing touches#
✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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