[docs]: Moved Start Pages to Guides Section #5440
Conversation
WalkthroughStandardizes docs routing by introducing guide/ subpaths across React and Solid guides, restructures navigation in docs/start/config.json (adds Solid group, Next.js migration, removes Tutorials), updates multiple internal links accordingly, and adds Solid guide pages that reference React guides with replacement mappings. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
docs/start/config.json(1 hunks)docs/start/framework/react/build-from-scratch.md(1 hunks)docs/start/framework/react/getting-started.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/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/solid/guide/environment-functions.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/databases.mddocs/start/framework/solid/guide/server-functions.mddocs/start/framework/solid/guide/reading-writing-file.mddocs/start/framework/react/build-from-scratch.mddocs/start/framework/solid/quick-start.mddocs/start/framework/solid/build-from-scratch.mddocs/start/framework/react/getting-started.mddocs/start/framework/solid/guide/spa-mode.mddocs/start/framework/solid/guide/authentication-overview.mddocs/start/framework/react/quick-start.mddocs/start/framework/solid/guide/middleware.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/solid/guide/environment-functions.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/databases.mddocs/start/framework/solid/guide/server-functions.mddocs/start/framework/solid/guide/reading-writing-file.mddocs/start/framework/react/build-from-scratch.mddocs/start/framework/solid/quick-start.mddocs/start/framework/solid/build-from-scratch.mddocs/start/framework/react/getting-started.mddocs/start/framework/solid/guide/spa-mode.mddocs/start/framework/solid/guide/authentication-overview.mddocs/start/framework/react/quick-start.mddocs/start/config.jsondocs/start/framework/solid/guide/middleware.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
PR: TanStack/router#0
File: AGENTS.md:0-0
Timestamp: 2025-09-23T17:36:12.598Z
Learning: Applies to docs/{router,start}/** : Place router docs under docs/router/ and start framework docs under docs/start/
Learnt from: CR
PR: TanStack/router#0
File: AGENTS.md:0-0
Timestamp: 2025-09-23T17:36:12.598Z
Learning: Applies to docs/**/*.{md,mdx} : Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)
🪛 markdownlint-cli2 (0.18.1)
docs/start/framework/react/getting-started.md
10-10: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
docs/start/framework/solid/guide/server-functions.md (1)
2-2: Reference update looks goodNew ref path matches the relocated React guide under
/guide/, so the Solid mirror will resolve correctly.
| "label": "Tailwind CSS Integration", | ||
| "to": "framework/react/tailwind-integration" | ||
| }, | ||
| { | ||
| "label": "Migrate from Next.js", | ||
| "to": "framework/react/migrate-from-next-js" | ||
| "to": "framework/solid/guide/tailwind-integration" | ||
| } |
There was a problem hiding this comment.
Fix React Tailwind link target.
The “Tailwind CSS Integration” entry in the React guides points to framework/solid/guide/tailwind-integration, which routes users into the Solid docs. This breaks the React navigation. Please update the to value to the React guide path (e.g. framework/react/guide/tailwind-integration).
🤖 Prompt for AI Agents
In docs/start/config.json around lines 149 to 151, the "Tailwind CSS
Integration" nav entry incorrectly links to the Solid guide; update the "to"
value to point to the React guide path (for example change
framework/solid/guide/tailwind-integration to
framework/react/guide/tailwind-integration) so the React navigation routes to
the correct Tailwind integration page.
|
|
||
| > [!NOTE] | ||
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../routing) guide. | ||
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../guide/routing) guide. |
There was a problem hiding this comment.
Fix the routing link path
../guide/routing escapes the framework folder and lands on a non-existent page. Please keep the link scoped to the React guide directory.
-> If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../guide/routing) guide.
+> If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](./guide/routing) guide.Based on learnings
📝 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.
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../guide/routing) guide. | |
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](./guide/routing) guide. |
🤖 Prompt for AI Agents
docs/start/framework/react/build-from-scratch.md around line 7: the link
currently points to ../guide/routing which escapes the React folder and resolves
to a non-existent page; change the link to keep it scoped to the React guide
directory by replacing ../guide/routing with ./guide/routing (or
./guide/routing.md if you reference filenames), so the link points to
docs/start/framework/react/guide/routing.
| - Refer to a migration guide for your specific framework: | ||
| - [Next.js](../migrate-from-next-js) | ||
| - [React Router](../migrate-from-react-router) (Including React Router 7 "Data Mode") | ||
| - [Next.js](../guide/migrate-from-next-js) |
There was a problem hiding this comment.
Keep React guide links relative to the React directory
Both links should stay within framework/react/guide; the current ../guide/... form points at a missing shared folder.
- - [Next.js](../guide/migrate-from-next-js)
+ - [Next.js](./guide/migrate-from-next-js)
-Unless you chose to build a project from scratch, you can now move on to the [Routing](../guide/routing) guide to learn how to use TanStack Start!
+Unless you chose to build a project from scratch, you can now move on to the [Routing](./guide/routing) guide to learn how to use TanStack Start!Based on learnings
Also applies to: 24-24
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
10-10: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/start/framework/react/getting-started.md around lines 10 and 24, the
links use ../guide/... which points outside the React directory and breaks;
update both links to remain inside the React guide folder by changing
../guide/migrate-from-next-js (and the similar link at line 24) to
guide/migrate-from-next-js (or ./guide/migrate-from-next-js) so they resolve
relative to framework/react/guide.
| If you'd like to use a different example, you can replace `start-basic` above with the slug of the example you'd like to use from the list below. | ||
|
|
||
| Once you've cloned the example you want, head back to the [Routing](../routing) guide to learn how to use TanStack Start! | ||
| Once you've cloned the example you want, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start! |
There was a problem hiding this comment.
Fix routing guide links
../guide/routing exits the React directory. Please target the React guide location directly.
-Once you've cloned the example you want, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start!
+Once you've cloned the example you want, head back to the [Routing](./guide/routing) guide to learn how to use TanStack Start!
-Once you've clone or deployed an example, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start!
+Once you've clone or deployed an example, head back to the [Routing](./guide/routing) guide to learn how to use TanStack Start!Based on learnings
Also applies to: 69-69
🤖 Prompt for AI Agents
In docs/start/framework/react/quick-start.md around lines 33 and 69, the
relative link ../guide/routing points outside the React directory; update both
links to the correct React-specific path (e.g., ../react/guide/routing or the
actual React guide location in the docs tree) so they resolve to the React
routing guide instead of exiting the React directory; ensure the same corrected
path is used for both occurrences.
|
|
||
| > [!NOTE] | ||
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../routing) guide. | ||
| > If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../guide/routing) guide. |
There was a problem hiding this comment.
Keep Solid guide links within the framework directory
Both updated anchors jump up a level (../guide/...) and will 404 because the Solid guides live under framework/solid/guide/. Point them directly at that subfolder instead.
-> If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](../guide/routing) guide.
+> If you chose to quick start with an example or cloned project, you can skip this guide and move on to the [Routing](./guide/routing) guide.
-You want to deploy your application? Check out the [hosting guide](../guide/hosting.md).
+You want to deploy your application? Check out the [hosting guide](./guide/hosting).Based on learnings
Also applies to: 260-260
🤖 Prompt for AI Agents
In docs/start/framework/solid/build-from-scratch.md around lines 7 and 260, the
two links use ../guide/... which points outside the framework/solid directory
and will 404; update both anchors to point to the local subfolder
(framework/solid/guide/...) by changing the relative paths so they reference the
guide files under framework/solid/guide (i.e., replace ../guide/... with
guide/... or with the correct relative path from this file into
framework/solid/guide).
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| ref: docs/start/framework/react/databases.md | |||
| ref: docs/start/framework/react/guide/databases.md | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Normalize the ref link path
Please drop the docs/ prefix so the link stays relative to the docs/ root, per our docs-link guideline. A simple update like below should keep the reference working while honoring the convention.
-ref: docs/start/framework/react/guide/databases.md
+ref: ./start/framework/react/guide/databases.mdAs per coding guidelines.
📝 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/databases.md | |
| ref: ./start/framework/react/guide/databases.md |
🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/databases.md around line 2, the ref link
currently includes the redundant "docs/" prefix; update the reference to be
relative to the docs root (remove the "docs/" prefix) so it reads
start/framework/react/guide/databases.md, leaving the rest of the file
unchanged.
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| ref: docs/start/framework/react/middleware.md | |||
| ref: docs/start/framework/react/guide/middleware.md | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Use relative doc reference.
Per the docs guidelines, internal references should be relative to the docs/ root (e.g., ./guide/...). Please drop the leading docs/ so this becomes start/framework/react/guide/middleware.md.
🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/middleware.md around line 2 the internal
reference is an absolute path starting with "docs/"; change it to a relative
path from the docs/ root by removing the leading "docs/" so the ref becomes
"start/framework/react/guide/middleware.md" to follow the docs guideline for
relative doc references.
| ref: docs/start/framework/react/guide/path-aliases.md | ||
| replace: | ||
| { '@tanstack/react-start': '@tanstack/solid-start', 'React': 'SolidJS' } |
There was a problem hiding this comment.
Make ref relative to docs/ root.
Coding guidelines require internal doc refs to be relative to the docs/ folder (./…). Please change this to ./start/framework/react/guide/path-aliases.md so it complies.
🤖 Prompt for AI Agents
docs/start/framework/solid/guide/path-aliases.md lines 2-4: the internal
documentation reference is absolute
("docs/start/framework/react/guide/path-aliases.md"); change it to a relative
path from the docs/ root by prefixing with ./ so it becomes
./start/framework/react/guide/path-aliases.md to satisfy the coding guideline
requiring internal doc refs be relative to the docs/ folder.
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| ref: docs/start/framework/react/server-entry-point.md | |||
| ref: docs/start/framework/react/guide/server-entry-point.md | |||
There was a problem hiding this comment.
Adjust ref path to follow docs link guideline.
The docs guidance asks for internal links relative to the docs/ root (e.g., ./guide/...). Please update the ref to ./start/framework/react/guide/server-entry-point.md.
🤖 Prompt for AI Agents
In docs/start/framework/solid/guide/server-entry-point.md around line 2, the ref
currently points to docs/start/framework/react/guide/server-entry-point.md using
an absolute/docs-root path; update the ref to use a relative docs-root link per
guideline by changing it to ./start/framework/react/guide/server-entry-point.md
so the internal link is relative to the docs/ root.
| If you'd like to use a different example, you can replace `start-basic` above with the slug of the example you'd like to use from the list below. | ||
|
|
||
| Once you've cloned the example you want, head back to the [Routing](../routing) guide to learn how to use TanStack Start! | ||
| Once you've cloned the example you want, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start! |
There was a problem hiding this comment.
Update routing guide references
The Solid routing guide lives under ./guide/; using ../guide/ makes the link point outside the Solid tree.
-Once you've cloned the example you want, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start!
+Once you've cloned the example you want, head back to the [Routing](./guide/routing) guide to learn how to use TanStack Start!
-Once you've clone or deployed an example, head back to the [Routing](../guide/routing) guide to learn how to use TanStack Start!
+Once you've clone or deployed an example, head back to the [Routing](./guide/routing) guide to learn how to use TanStack Start!Based on learnings
Also applies to: 63-63
🤖 Prompt for AI Agents
In docs/start/framework/solid/quick-start.md around lines 33 and 63, the routing
link uses a relative path "../guide/routing" which points outside the Solid
tree; update both occurrences to "./guide/routing" so the link correctly
references the guide directory within the Solid tree.
1 participant
Moved files irrelevant to "Getting Started" section to "Guides" & updated related links / references.
Summary by CodeRabbit