-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs: migrate Start example guidance to Builder and baselines #6698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -122,7 +122,7 @@ This pattern combines TanStack Router with a client-side i18n library. It is sui | |||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Paraglide provides type-safe translations, locale detection, and URL localization that pair naturally with TanStack Router. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| **GitHub example:** | ||||||||||||||||||||||||||||||
| **Reference implementation:** | ||||||||||||||||||||||||||||||
| [https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide](https://github.com/TanStack/router/tree/main/examples/react/i18n-paraglide) | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Project Setup | ||||||||||||||||||||||||||||||
|
|
@@ -168,8 +168,10 @@ This pattern integrates i18n at the routing and server layers. It is suitable wh | |||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### 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) | ||||||||||||||||||||||||||||||
|
Comment on lines
169
to
+174
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Convert Start guide links to docs-relative paths. 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
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Server Middleware (SSR) | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -488,9 +488,9 @@ const composedRewrite = composeRewrites([ | |
|
|
||
| ## Examples | ||
|
|
||
| Complete working examples are available in the TanStack Router repository: | ||
| 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) | ||
|
Comment on lines
+491
to
495
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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 |
||
| - [Solid + TanStack Start + Paraglide (SSR i18n)](https://github.com/TanStack/router/tree/main/examples/solid/start-i18n-paraglide) | ||
| - [Solid + TanStack Start + Paraglide (SSR i18n)](https://tanstack.com/router/latest/docs/framework/solid/start/guide/middleware) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -264,10 +264,10 @@ const authMiddleware = createMiddleware({ type: 'function' }) | |
| **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. | ||
|
|
||
|
Comment on lines
264
to
271
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 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 |
||
| ## Performance Considerations | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -540,13 +540,13 @@ export const loginFn = createServerFn({ method: 'POST' }) | |
| }) | ||
| ``` | ||
|
|
||
| ## Working Examples | ||
| ## 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 | ||
|
Comment on lines
+543
to
+549
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use a docs-relative link for “Client-side Context Auth.”
As per coding guidelines “Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)”. 🤖 Prompt for AI Agents |
||
|
|
||
| ## Migration from Other Solutions | ||
|
|
||
|
|
@@ -607,4 +607,4 @@ When implementing authentication, consider: | |
| - **Monitoring**: Add logging and monitoring for authentication events | ||
| - **Compliance**: Ensure compliance with relevant regulations if storing personal data | ||
|
|
||
| For other authentication approaches, check the [Authentication Overview](./authentication-overview.md). For specific integration help, explore our [working examples](https://github.com/TanStack/router/tree/main/examples/react). | ||
| For other authentication approaches, check the [Authentication Overview](./authentication-overview.md). For specific integration help, use [TanStack Builder](https://tanstack.com/builder) and the auth guides linked above. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ That said, if you **know with certainty** that you will not need any of the abov | |
|
|
||
| ## Are there limitations? | ||
|
|
||
| The only relevant limitation is that TanStack Start does not currently support React Server Components, **but we are actively working on integration and expect to support them in the near future.** | ||
| TanStack Start supports React Server Components. | ||
|
|
||
|
Comment on lines
35
to
38
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Check for existing RSC support details in docs
rg -n "React Server Components|RSC" docs/start/framework/react -A 2 -B 2Repository: TanStack/router Length of output: 10867 🏁 Script executed: #!/bin/bash
# Read the target file to see full context around lines 35-38
cat -n docs/start/framework/react/overview.md | head -50Repository: TanStack/router Length of output: 3857 Qualify RSC support statement to match comparison table status. The statement "TanStack Start supports React Server Components" should indicate this is in active development. Either add "in active development" as qualifier or link to the comparison guide which provides accurate status context. 🤖 Prompt for AI Agents |
||
| Otherwise, TanStack Start provides the same capability as other full-stack frameworks like Next.js, Remix, etc, with even more features and a more powerful developer experience. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
As per coding guidelines, "Use internal docs links relative to docs/ folder (e.g., ./guide/data-loading)".
📝 Committable suggestion
🤖 Prompt for AI Agents