docs: migrate Start example guidance to Builder and baselines#6698
Open
tannerlinsley wants to merge 1 commit intomainfrom
Open
docs: migrate Start example guidance to Builder and baselines#6698tannerlinsley wants to merge 1 commit intomainfrom
tannerlinsley wants to merge 1 commit intomainfrom
Conversation
Contributor
📝 WalkthroughWalkthroughConsolidates TanStack Start examples by deprecating standalone example projects in favor of TanStack Builder and guide-based documentation. Updates guides to reference new authentication and hosting patterns, removes the Examples config section, and marks multiple example directories as deprecated with historical references. Changes
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
|
View your CI Pipeline Execution ↗ for commit b5329b8
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/arktype-adapter
@tanstack/eslint-plugin-router
@tanstack/history
@tanstack/nitro-v2-vite-plugin
@tanstack/react-router
@tanstack/react-router-devtools
@tanstack/react-router-ssr-query
@tanstack/react-start
@tanstack/react-start-client
@tanstack/react-start-server
@tanstack/router-cli
@tanstack/router-core
@tanstack/router-devtools
@tanstack/router-devtools-core
@tanstack/router-generator
@tanstack/router-plugin
@tanstack/router-ssr-query-core
@tanstack/router-utils
@tanstack/router-vite-plugin
@tanstack/solid-router
@tanstack/solid-router-devtools
@tanstack/solid-router-ssr-query
@tanstack/solid-start
@tanstack/solid-start-client
@tanstack/solid-start-server
@tanstack/start-client-core
@tanstack/start-fn-stubs
@tanstack/start-plugin-core
@tanstack/start-server-core
@tanstack/start-static-server-functions
@tanstack/start-storage-context
@tanstack/valibot-adapter
@tanstack/virtual-file-routes
@tanstack/vue-router
@tanstack/vue-router-devtools
@tanstack/vue-router-ssr-query
@tanstack/vue-start
@tanstack/vue-start-client
@tanstack/vue-start-server
@tanstack/zod-adapter
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 19
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
examples/react/i18n-paraglide/README.md (1)
70-76:⚠️ Potential issue | 🟠 MajorFix paraglide middleware callback to preserve the original request URL.
The callback in the example should reference the outer
reqinstead of the processedrequestparameter. Using({ request })causes the middleware to pre-process URL rewrites before the router's rewrite logic executes, breaking the Router's flow.This pattern is already correct in
docs/router/guide/internationalization-i18n.mdand the actual implementation ate2e/react-start/i18n-paraglide/src/server.ts.✅ Proposed fix
export default { fetch(req: Request): Promise<Response> { - return paraglideMiddleware(req, ({ request }) => handler.fetch(request)) + return paraglideMiddleware(req, () => handler.fetch(req)) }, }🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/react/i18n-paraglide/README.md` around lines 70 - 76, The middleware callback currently destructures and passes the processed `{ request }` into `handler.fetch`, which causes URL rewrites to run too early; update the `paraglideMiddleware` call so the callback uses the outer `req` and passes that into `handler.fetch` (i.e., replace the `({ request }) => handler.fetch(request)` callback with one that calls `handler.fetch(req)`), keeping the `paraglideMiddleware` and `handler.fetch` references intact.docs/start/framework/react/guide/authentication-overview.md (1)
229-239:⚠️ Potential issue | 🟡 MinorUse relative internal docs links per guidelines.
Line 229-239 include internal docs links via absolute
/router/latest/docs/...paths. Please convert them to docs-relative links.Suggested update
-- [Router Authentication Guide](/router/latest/docs/framework/react/guide/authenticated-routes.md) +- [Router Authentication Guide](../../../../router/guide/authenticated-routes.md) -- [Router How-to Guides](/router/latest/docs/framework/react/how-to/README.md#authentication) +- [Router How-to Guides](../../../../router/framework/react/how-to/README.md#authentication)As per coding guidelines, "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/start/framework/react/guide/authentication-overview.md` around lines 229 - 239, Summary: Replace absolute internal docs links with docs-relative links. Fix: in authentication-overview.md change the absolute links "/router/latest/docs/framework/react/guide/authenticated-routes.md" and "/router/latest/docs/framework/react/how-to/README.md#authentication" to docs-relative paths (e.g., "./guide/authenticated-routes.md" and "./how-to/README.md#authentication") so they follow the "use internal docs links relative to docs/ folder" guideline.
🧹 Nitpick comments (3)
.github/ISSUE_TEMPLATE/bug_report.yml (1)
45-45: Minor pre-existing typo: "will may" → "will" or "may".Adjacent line 45 contains a grammatical error: "Your bug will may get fixed" should be "Your bug may get fixed" (or "will get fixed"). Since you're editing this section, consider fixing it.
📝 Suggested fix
- - Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `router` npm package / dependency. + - Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than the `router` npm package / dependency.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/ISSUE_TEMPLATE/bug_report.yml at line 45, Replace the grammatically incorrect phrase "Your bug will may get fixed much faster if we can run your code and it doesn't have dependencies other than the `router` npm package / dependency." with a corrected version such as "Your bug may get fixed much faster if we can run your code and it doesn't have dependencies other than the `router` npm package / dependency." — remove the extraneous "will" (or choose "will" and remove "may") so the sentence reads cleanly.examples/react/start-bare/README.md (1)
16-16: Consider using a relative path for the example link.The link uses a full GitHub URL to reference a sibling example directory. While the coding guideline specifically mentions docs/ folder links, using a relative path would improve maintainability and work in local development environments.
🔗 Proposed refactor to use relative path
-- [React `start-basic`](https://github.com/TanStack/router/tree/main/examples/react/start-basic) +- [React `start-basic`](../start-basic/)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@examples/react/start-bare/README.md` at line 16, The README.md contains an absolute GitHub link for the sibling example ("React `start-basic`") which should be replaced with a relative repository path; update the link target in the README.md line that currently points to https://github.com/TanStack/router/tree/main/examples/react/start-basic to a relative path like ../start-basic or ./../start-basic (so the Markdown link text "React `start-basic`" points to the local examples/react/start-basic folder) to improve maintainability and local dev browsing.docs/router/how-to/setup-authentication.md (1)
481-485: Remove the duplicate “Authenticated Routes Guide” entry.
The related resources list now contains the same link twice with different descriptions.Proposed fix
- - [Authenticated Routes Guide](../guide/authenticated-routes.md) - Detailed conceptual guide - - [Router Context Guide](../guide/router-context.md) - Understanding context in TanStack Router - - [Authenticated Routes Guide](../guide/authenticated-routes.md) - End-to-end route protection patterns + - [Authenticated Routes Guide](../guide/authenticated-routes.md) - End-to-end route protection patterns + - [Router Context Guide](../guide/router-context.md) - Understanding context in TanStack Router🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/router/how-to/setup-authentication.md` around lines 481 - 485, Remove the duplicate "Authenticated Routes Guide" entry in the Related Resources list by keeping only one list item that points to ../guide/authenticated-routes.md; update the remaining item's description to the preferred phrasing (either "Detailed conceptual guide" or "End-to-end route protection patterns") and delete the other duplicate line referencing the same URL.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/router/guide/authenticated-routes.md`:
- Line 338: Replace the absolute internal docs URL in the link labeled "TanStack
Start Authentication Overview" with a docs-relative path: change
"/router/latest/docs/framework/react/start/guide/authentication-overview" to a
docs-relative link (e.g.,
"./framework/react/start/guide/authentication-overview") keeping the link text
unchanged so it follows the guideline to use internal links relative to the
docs/ folder.
In `@docs/router/guide/internationalization-i18n.md`:
- Around line 169-174: Replace the absolute TanStack docs URLs with
docs-relative paths in the markdown: change the link targets for "React Start
Middleware" and "Solid Start Middleware" (currently pointing to
https://tanstack.com/router/.../framework/react/start/guide/middleware and
.../framework/solid/start/guide/middleware) to relative paths under the docs/
folder (e.g., docs/.../framework/react/start/guide/middleware and
docs/.../framework/solid/start/guide/middleware) so internal links are relative
to the docs root.
In `@docs/router/guide/url-rewrites.md`:
- Around line 491-495: Replace the absolute tanstack.com URL for the "React +
TanStack Start + Paraglide (SSR i18n)" link with a docs-relative path per
guidelines: find the link text "React + TanStack Start + Paraglide (SSR i18n)"
and change its target from
"https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware"
to a relative docs path (e.g., "./framework/react/start/guide/middleware") so
the Start middleware link is internal and relative to the docs/ folder.
In `@docs/start/framework/react/comparison.md`:
- Around line 264-271: The RSC support status in the "Current Status" block is
inconsistent with the table at line 44; update the "TanStack Start: Supported"
entry to either "TanStack Start: In active development (partial/experimental
support)" or add a parenthetical clarifying what "Supported" means relative to
active development, so the "RSC" and "TanStack Start" statuses match the earlier
table.
In `@docs/start/framework/react/guide/authentication.md`:
- Around line 543-549: The link for "Client-side Context Auth" uses an
absolute/internal path (/router/latest/docs/...) instead of a docs-relative
link; update the Markdown link target for the "Client-side Context Auth" bullet
to a docs-relative path by replacing the href with a ./-relative URL (e.g.,
./router/latest/docs/framework/react/guide/authenticated-routes) so it follows
the guideline to use internal docs links relative to the docs/ folder.
In `@docs/start/framework/react/overview.md`:
- Around line 35-38: Update the sentence under the "## Are there limitations?"
heading that currently reads "TanStack Start supports React Server Components"
to clarify the status by either appending " (in active development)" or
replacing it with a linked phrase to the comparison guide, e.g. "TanStack Start
supports React Server Components — see the comparison guide for current status
(./comparison#react-server-components-rsc)"; ensure you change the exact
sentence "TanStack Start supports React Server Components" so the doc accurately
reflects active development status.
In `@docs/start/framework/react/quick-start.md`:
- Around line 18-20: The fenced code block in quick-start.md currently lacks a
language tag (MD040); update the triple-backtick block around "npx `@tanstack/cli`
create" to include a language label such as "bash" so the block reads ```bash
... ```, ensuring the code fence for that command in the React quick-start
example is properly annotated.
In `@docs/start/framework/solid/guide/authentication.md`:
- Line 602: Replace the absolute internal docs URL in the "How-to Guides" link
with a docs-relative path: change the href
`/router/latest/docs/framework/solid/how-to/README.md#authentication` used in
the "How-to Guides" reference to the relative
`../how-to/README.md#authentication` so the link follows the internal
docs-relative linking guideline.
In `@docs/start/framework/solid/guide/hosting.md`:
- Around line 402-406: Replace the example TanStack Start creation command in
the snippet that currently lacks a project name and uses a lowercase framework
flag; update the command to include a required project name (e.g., "my-app") and
use the correct framework flag casing of "--framework Solid" so readers run the
CLI with a project name and the capitalized framework identifier.
In `@docs/start/framework/solid/quick-start.md`:
- Around line 18-20: The fenced code block containing the CLI command "npx
`@tanstack/cli` create --framework solid" is missing a language hint; update that
block to include a language tag (e.g., bash) after the opening backticks so the
block becomes "```bash" to satisfy MD040 and enable proper syntax highlighting
for the command.
In `@examples/react/start-bare/README.md`:
- Line 12: Replace the absolute tanstack.com URL in the README link "[Start
React Quick Start]" with a relative docs path so internal links point to the
local docs; specifically change the href
"https://tanstack.com/router/latest/docs/framework/react/start/quick-start" to a
relative path such as "/docs/framework/react/start/quick-start" while keeping
the link text unchanged.
In `@examples/react/start-basic-auth/README.md`:
- Around line 12-13: Replace the absolute docs URLs with docs-relative links:
change the link texts pointing to "Start React Quick Start" and "Start React
Guides" to use relative paths under the docs folder (e.g.,
./framework/react/start/quick-start and ./framework/react/start/guide/routing)
so they follow the internal docs link guideline.
In `@examples/react/start-basic-authjs/README.md`:
- Around line 12-13: Replace the two external tanstack.com links in README.md:
change the link target for "Start React Quick Start" to the internal relative
path ../../../docs/start/framework/react/quick-start.md and change the link
target for "Start React Guides" to
../../../docs/start/framework/react/guide/routing.md so both links point to
internal docs rather than external URLs.
In `@examples/react/start-basic-cloudflare/README.md`:
- Around line 12-13: Replace the two absolute docs links in README.md
("https://tanstack.com/router/latest/docs/framework/react/start/quick-start" and
"https://tanstack.com/router/latest/docs/framework/react/start/guide/hosting")
with docs-relative paths so they point into the docs/ tree (e.g., use
"./start/quick-start" and "./start/guide/hosting" or the canonical relative form
used across the repo) to comply with the internal docs linking guideline.
In `@examples/react/start-basic-react-query/README.md`:
- Line 12: Replace the absolute URL in the "Start React Quick Start" link with a
docs-relative path per guidelines; locate the markdown anchor text "Start React
Quick Start" in README.md and change the href from
"https://tanstack.com/router/latest/docs/framework/react/start/quick-start" to
the appropriate relative docs link (for example "./start/quick-start" or
"./quick-start") so the link points inside the docs folder.
In `@examples/react/start-basic-rsc/README.md`:
- Around line 12-13: Replace the absolute tanstack.com links in README.md for
the "Start React Quick Start" and "Start React Guides" entries with
docs-relative paths; specifically change the hrefs that point to
/router/latest/docs/framework/react/start/quick-start and
/router/latest/docs/framework/react/start/guide/routing to use relative docs
paths such as ./start/quick-start and ./start/guide/routing (keeping the same
link text), so the links are internal and follow the "use internal docs links
relative to docs/ folder" guideline.
In `@examples/react/start-basic-static/README.md`:
- Around line 12-13: Replace the two absolute docs URLs in
examples/react/start-basic-static/README.md with docs-relative links: change the
"Start React Quick Start" href to the docs-relative path for the quick-start
page and the "Static Prerendering" href to the docs-relative path for the
static-prerendering guide (use the same relative style as "./guide/..." or
"./start/..." per the project's docs linking convention), leaving the link text
unchanged so the anchors remain "Start React Quick Start" and "Static
Prerendering".
In `@examples/react/start-bun/README.md`:
- Line 12: Replace the absolute tanstack.com URL in the markdown link labeled
"[Start React Hosting Guide]" with a docs-relative path under the docs/ folder
(for example "./guide/hosting" or the correct relative path to the hosting guide
in docs/); update only the link target so the link becomes relative to the docs/
directory while keeping the link text unchanged.
In `@examples/react/start-clerk-basic/README.md`:
- Around line 10-13: Replace the absolute external link to the Start guide with
a docs-relative path: locate the "Authentication Overview" link text in the
README.md and change its URL from
"https://tanstack.com/router/latest/docs/framework/react/start/guide/authentication-overview"
to the docs-relative path under the docs/ folder (e.g.,
"docs/framework/react/start/guide/authentication-overview" or the correct
relative path used by the repo), ensuring the link text "Authentication
Overview" remains unchanged.
---
Outside diff comments:
In `@docs/start/framework/react/guide/authentication-overview.md`:
- Around line 229-239: Summary: Replace absolute internal docs links with
docs-relative links. Fix: in authentication-overview.md change the absolute
links "/router/latest/docs/framework/react/guide/authenticated-routes.md" and
"/router/latest/docs/framework/react/how-to/README.md#authentication" to
docs-relative paths (e.g., "./guide/authenticated-routes.md" and
"./how-to/README.md#authentication") so they follow the "use internal docs links
relative to docs/ folder" guideline.
In `@examples/react/i18n-paraglide/README.md`:
- Around line 70-76: The middleware callback currently destructures and passes
the processed `{ request }` into `handler.fetch`, which causes URL rewrites to
run too early; update the `paraglideMiddleware` call so the callback uses the
outer `req` and passes that into `handler.fetch` (i.e., replace the `({ request
}) => handler.fetch(request)` callback with one that calls
`handler.fetch(req)`), keeping the `paraglideMiddleware` and `handler.fetch`
references intact.
---
Nitpick comments:
In @.github/ISSUE_TEMPLATE/bug_report.yml:
- Line 45: Replace the grammatically incorrect phrase "Your bug will may get
fixed much faster if we can run your code and it doesn't have dependencies other
than the `router` npm package / dependency." with a corrected version such as
"Your bug may get fixed much faster if we can run your code and it doesn't have
dependencies other than the `router` npm package / dependency." — remove the
extraneous "will" (or choose "will" and remove "may") so the sentence reads
cleanly.
In `@docs/router/how-to/setup-authentication.md`:
- Around line 481-485: Remove the duplicate "Authenticated Routes Guide" entry
in the Related Resources list by keeping only one list item that points to
../guide/authenticated-routes.md; update the remaining item's description to the
preferred phrasing (either "Detailed conceptual guide" or "End-to-end route
protection patterns") and delete the other duplicate line referencing the same
URL.
In `@examples/react/start-bare/README.md`:
- Line 16: The README.md contains an absolute GitHub link for the sibling
example ("React `start-basic`") which should be replaced with a relative
repository path; update the link target in the README.md line that currently
points to
https://github.com/TanStack/router/tree/main/examples/react/start-basic to a
relative path like ../start-basic or ./../start-basic (so the Markdown link text
"React `start-basic`" points to the local examples/react/start-basic folder) to
improve maintainability and local dev browsing.
| - [Basic Authentication Example](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes) - Simple authentication with context | ||
| - [Firebase Authentication](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes-firebase) - Firebase Auth integration | ||
| - [TanStack Start Auth Examples](https://github.com/TanStack/router/tree/main/examples/react) - Various auth implementations with TanStack Start | ||
| - [TanStack Start Authentication Overview](/router/latest/docs/framework/react/start/guide/authentication-overview) - Compare hosted, OSS, and DIY auth approaches for Start |
Contributor
There was a problem hiding this comment.
Use relative internal docs links per guidelines.
Line 338 uses an internal docs link via /router/latest/docs/.... Please convert to a docs-relative link.
Suggested update
-- [TanStack Start Authentication Overview](/router/latest/docs/framework/react/start/guide/authentication-overview)
+- [TanStack Start Authentication Overview](../../start/framework/react/guide/authentication-overview.md)As per coding guidelines, "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
📝 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.
Suggested change
| - [TanStack Start Authentication Overview](/router/latest/docs/framework/react/start/guide/authentication-overview) - Compare hosted, OSS, and DIY auth approaches for Start | |
| - [TanStack Start Authentication Overview](../../start/framework/react/guide/authentication-overview.md) - Compare hosted, OSS, and DIY auth approaches for Start |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/router/guide/authenticated-routes.md` at line 338, Replace the absolute
internal docs URL in the link labeled "TanStack Start Authentication Overview"
with a docs-relative path: change
"/router/latest/docs/framework/react/start/guide/authentication-overview" to a
docs-relative link (e.g.,
"./framework/react/start/guide/authentication-overview") keeping the link text
unchanged so it follows the guideline to use internal links relative to the
docs/ folder.
Comment on lines
169
to
+174
| ### TanStack Start + Paraglide | ||
|
|
||
| **GitHub example:** | ||
| [https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide](https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide) | ||
| **Start guides:** | ||
|
|
||
| - [React Start Middleware](https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware) | ||
| - [Solid Start Middleware](https://tanstack.com/router/latest/docs/framework/solid/start/guide/middleware) |
Contributor
There was a problem hiding this comment.
Convert Start guide links to docs-relative paths.
Internal docs links should be relative to the docs/ folder.
Proposed fix
- - [React Start Middleware](https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware)
- - [Solid Start Middleware](https://tanstack.com/router/latest/docs/framework/solid/start/guide/middleware)
+ - [React Start Middleware](../../start/framework/react/guide/middleware.md)
+ - [Solid Start Middleware](../../start/framework/solid/guide/middleware.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.
Suggested change
| ### TanStack Start + Paraglide | |
| **GitHub example:** | |
| [https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide](https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide) | |
| **Start guides:** | |
| - [React Start Middleware](https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware) | |
| - [Solid Start Middleware](https://tanstack.com/router/latest/docs/framework/solid/start/guide/middleware) | |
| ### TanStack Start + Paraglide | |
| **Start guides:** | |
| - [React Start Middleware](../../start/framework/react/guide/middleware.md) | |
| - [Solid Start Middleware](../../start/framework/solid/guide/middleware.md) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/router/guide/internationalization-i18n.md` around lines 169 - 174,
Replace the absolute TanStack docs URLs with docs-relative paths in the
markdown: change the link targets for "React Start Middleware" and "Solid Start
Middleware" (currently pointing to
https://tanstack.com/router/.../framework/react/start/guide/middleware and
.../framework/solid/start/guide/middleware) to relative paths under the docs/
folder (e.g., docs/.../framework/react/start/guide/middleware and
docs/.../framework/solid/start/guide/middleware) so internal links are relative
to the docs root.
Comment on lines
+491
to
495
| Reference implementations and guides: | ||
|
|
||
| - [React + Paraglide (Client-side i18n)](https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide) | ||
| - [React + TanStack Start + Paraglide (SSR i18n)](https://github.com/TanStack/router/tree/main/examples/react/start-i18n-paraglide) | ||
| - [React + TanStack Start + Paraglide (SSR i18n)](https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware) | ||
| - [Solid + Paraglide (Client-side i18n)](https://github.com/TanStack/router/tree/main/examples/solid/i18n-paraglide) |
Contributor
There was a problem hiding this comment.
Switch Start middleware links to docs-relative paths.
The Start middleware docs are internal; please use relative links instead of absolute tanstack.com URLs.
As per coding guidelines "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/router/guide/url-rewrites.md` around lines 491 - 495, Replace the
absolute tanstack.com URL for the "React + TanStack Start + Paraglide (SSR
i18n)" link with a docs-relative path per guidelines: find the link text "React
+ TanStack Start + Paraglide (SSR i18n)" and change its target from
"https://tanstack.com/router/latest/docs/framework/react/start/guide/middleware"
to a relative docs path (e.g., "./framework/react/start/guide/middleware") so
the Start middleware link is internal and relative to the docs/ folder.
Comment on lines
264
to
271
| **Current Status**: | ||
|
|
||
| - **Next.js**: Full production support with extensive ecosystem | ||
| - **TanStack Start**: In active development, expected soon | ||
| - **TanStack Start**: Supported | ||
| - **React Router**: Experimental support available | ||
|
|
||
| RSC is still evolving, and TanStack Start is taking time to ensure the best possible implementation that aligns with its type-safety-first philosophy. | ||
| RSC is still evolving across the ecosystem. TanStack Start treats RSC as a composable primitive alongside Router and server functions. | ||
|
|
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Search for RSC-related statements in docs
rg -n "React Server Components|RSC" docs/ --context 3Repository: TanStack/router
Length of output: 14879
Align RSC support status with the comparison table on line 44.
The earlier status table on line 44 marks TanStack Start's RSC as 🛑 (In active development), but the section at lines 266-271 claims "TanStack Start: Supported" without qualification. Update this section to either match the "In active development" status or clarify what "Supported" means relative to the development status.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/start/framework/react/comparison.md` around lines 264 - 271, The RSC
support status in the "Current Status" block is inconsistent with the table at
line 44; update the "TanStack Start: Supported" entry to either "TanStack Start:
In active development (partial/experimental support)" or add a parenthetical
clarifying what "Supported" means relative to active development, so the "RSC"
and "TanStack Start" statuses match the earlier table.
Comment on lines
+543
to
+549
| ## Starter Paths | ||
|
|
||
| Study these implementations to understand different authentication patterns: | ||
| Use these paths depending on what you need: | ||
|
|
||
| - **[Basic Auth with Prisma](https://github.com/TanStack/router/tree/main/examples/react/start-basic-auth)** - Complete DIY implementation with database and sessions | ||
| - **[Supabase Integration](https://github.com/TanStack/router/tree/main/examples/react/start-supabase-basic)** - Third-party service integration example | ||
| - **[Client-side Context Auth](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes)** - Client-only authentication patterns | ||
| - **[TanStack Builder](https://tanstack.com/builder)** - Generate projects with hosted auth providers and deployment options | ||
| - **[Authentication Overview](./authentication-overview)** - Compare hosted, OSS, and DIY approaches | ||
| - **[Client-side Context Auth](/router/latest/docs/framework/react/guide/authenticated-routes)** - Client-only authentication patterns |
Contributor
There was a problem hiding this comment.
Use a docs-relative link for “Client-side Context Auth.”
/router/latest/docs/... is an internal docs link but not relative to docs/ as required. Please switch it to a ./-relative path from this file.
As per coding guidelines “Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)”.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/start/framework/react/guide/authentication.md` around lines 543 - 549,
The link for "Client-side Context Auth" uses an absolute/internal path
(/router/latest/docs/...) instead of a docs-relative link; update the Markdown
link target for the "Client-side Context Auth" bullet to a docs-relative path by
replacing the href with a ./-relative URL (e.g.,
./router/latest/docs/framework/react/guide/authenticated-routes) so it follows
the guideline to use internal docs links relative to the docs/ folder.
| ```sh | ||
| npx gitpick TanStack/router/tree/main/examples/react/start-basic-react-query start-basic-react-query | ||
| ``` | ||
| - [Start React Quick Start](https://tanstack.com/router/latest/docs/framework/react/start/quick-start) |
Contributor
There was a problem hiding this comment.
Use docs-relative links for internal docs.
The Start Quick Start link points to an internal doc but uses an absolute URL. Please switch to a docs-relative link (e.g., ./quick-start or the appropriate relative path) to match the docs-linking guideline.
As per coding guidelines "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/react/start-basic-react-query/README.md` at line 12, Replace the
absolute URL in the "Start React Quick Start" link with a docs-relative path per
guidelines; locate the markdown anchor text "Start React Quick Start" in
README.md and change the href from
"https://tanstack.com/router/latest/docs/framework/react/start/quick-start" to
the appropriate relative docs link (for example "./start/quick-start" or
"./quick-start") so the link points inside the docs folder.
Comment on lines
+12
to
+13
| - [Start React Quick Start](https://tanstack.com/router/latest/docs/framework/react/start/quick-start) | ||
| - [Start React Guides](https://tanstack.com/router/latest/docs/framework/react/start/guide/routing) |
Contributor
There was a problem hiding this comment.
Use docs-relative links for Start guides.
These point to internal docs but are absolute URLs. Please replace with docs-relative paths (e.g., ./quick-start, ./guide/routing from the appropriate docs location).
As per coding guidelines "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/react/start-basic-rsc/README.md` around lines 12 - 13, Replace the
absolute tanstack.com links in README.md for the "Start React Quick Start" and
"Start React Guides" entries with docs-relative paths; specifically change the
hrefs that point to /router/latest/docs/framework/react/start/quick-start and
/router/latest/docs/framework/react/start/guide/routing to use relative docs
paths such as ./start/quick-start and ./start/guide/routing (keeping the same
link text), so the links are internal and follow the "use internal docs links
relative to docs/ folder" guideline.
Comment on lines
+12
to
+13
| - [Start React Quick Start](https://tanstack.com/router/latest/docs/framework/react/start/quick-start) | ||
| - [Static Prerendering](https://tanstack.com/router/latest/docs/framework/react/start/guide/static-prerendering) |
Contributor
There was a problem hiding this comment.
Use relative internal docs links per guidelines.
Line 12-13 point to internal docs via full URLs. Please switch to docs-relative links.
Suggested update
-- [Start React Quick Start](https://tanstack.com/router/latest/docs/framework/react/start/quick-start)
-- [Static Prerendering](https://tanstack.com/router/latest/docs/framework/react/start/guide/static-prerendering)
+- [Start React Quick Start](../../../docs/start/framework/react/quick-start.md)
+- [Static Prerendering](../../../docs/start/framework/react/guide/static-prerendering.md)As per coding guidelines, "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
📝 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.
Suggested change
| - [Start React Quick Start](https://tanstack.com/router/latest/docs/framework/react/start/quick-start) | |
| - [Static Prerendering](https://tanstack.com/router/latest/docs/framework/react/start/guide/static-prerendering) | |
| - [Start React Quick Start](../../../docs/start/framework/react/quick-start.md) | |
| - [Static Prerendering](../../../docs/start/framework/react/guide/static-prerendering.md) |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/react/start-basic-static/README.md` around lines 12 - 13, Replace
the two absolute docs URLs in examples/react/start-basic-static/README.md with
docs-relative links: change the "Start React Quick Start" href to the
docs-relative path for the quick-start page and the "Static Prerendering" href
to the docs-relative path for the static-prerendering guide (use the same
relative style as "./guide/..." or "./start/..." per the project's docs linking
convention), leaving the link text unchanged so the anchors remain "Start React
Quick Start" and "Static Prerendering".
| ```sh | ||
| npx gitpick TanStack/router/tree/main/examples/react/start-bun start-bun | ||
| ``` | ||
| - [Start React Hosting Guide](https://tanstack.com/router/latest/docs/framework/react/start/guide/hosting) |
Contributor
There was a problem hiding this comment.
Use docs-relative link for internal guides.
The Start React Hosting Guide points to tanstack.com; per guidelines, internal docs links in .md should be relative to the docs/ folder. Please convert this to a docs-relative link (e.g., ./guide/hosting or the appropriate relative path under docs/). As per coding guidelines: "**/*.md: Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/react/start-bun/README.md` at line 12, Replace the absolute
tanstack.com URL in the markdown link labeled "[Start React Hosting Guide]" with
a docs-relative path under the docs/ folder (for example "./guide/hosting" or
the correct relative path to the hosting guide in docs/); update only the link
target so the link becomes relative to the docs/ directory while keeping the
link text unchanged.
Comment on lines
+10
to
13
| For topic-specific setup, use the Start guides: | ||
|
|
||
| ```sh | ||
| npx gitpick TanStack/router/tree/main/examples/react/start-clerk-basic start-clerk-basic | ||
| ``` | ||
| - [Authentication Overview](https://tanstack.com/router/latest/docs/framework/react/start/guide/authentication-overview) | ||
|
|
Contributor
There was a problem hiding this comment.
Use docs-relative link for the internal Start guide.
Per guidelines, internal docs links should be relative to the docs/ folder.
Proposed fix
-- [Authentication Overview](https://tanstack.com/router/latest/docs/framework/react/start/guide/authentication-overview)
+- [Authentication Overview](../../../docs/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.
Suggested change
| For topic-specific setup, use the Start guides: | |
| ```sh | |
| npx gitpick TanStack/router/tree/main/examples/react/start-clerk-basic start-clerk-basic | |
| ``` | |
| - [Authentication Overview](https://tanstack.com/router/latest/docs/framework/react/start/guide/authentication-overview) | |
| For topic-specific setup, use the Start guides: | |
| - [Authentication Overview](../../../docs/start/framework/react/guide/authentication-overview.md) | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@examples/react/start-clerk-basic/README.md` around lines 10 - 13, Replace the
absolute external link to the Start guide with a docs-relative path: locate the
"Authentication Overview" link text in the README.md and change its URL from
"https://tanstack.com/router/latest/docs/framework/react/start/guide/authentication-overview"
to the docs-relative path under the docs/ folder (e.g.,
"docs/framework/react/start/guide/authentication-overview" or the correct
relative path used by the repo), ensuring the link text "Authentication
Overview" remains unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
npx @tanstack/cli createflowexamples/*/start-*apps with README tombstones and keep canonicalstart-basicbaselines for React/SolidSummary by CodeRabbit
Release Notes
Documentation
npm create @tanstack/start@latesttonpx @tanstack/cli createConfiguration
Migration