0
Fork 0
mirror of https://github.com/TanStack/router.git synced 2026-11-16 19:38:07 +00:00
Commit graph

127 commits

Author SHA1 Message Date
Magnus May
2ff5bc20f7
docs: add Bun production server guide for TanStack Start (#5237)
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Manuel Schiller <manuel.schiller@caligano.de>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-27 01:01:49 +02:00
Taegeon Alan Go
67dd66e77f
docs: nitro v3 plugin link in the hosting docs (#5253)
The nitro v3 plugin link is incorrect, fix with correct one

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated Vercel deployment guide to reference the correct Nitro v3 Vite
plugin (now nitro-nightly), keeping the BETA status note.
* Clarifies deployment steps for React users relying on Nitro v3,
reducing confusion from outdated plugin naming.
* Ensures alignment with current tooling to improve setup reliability
and developer confidence.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-26 20:38:59 +02:00
Manuel Schiller
159c8c182e docs: fix hosting 2025-09-26 05:55:35 +02:00
autofix-ci[bot]
d56f7dba53
ci: apply automated fixes 2025-09-26 03:50:01 +00:00
mattfysh-ai
bb6e2e31fe
docs: Fix cloudflare config (#5225) 2025-09-26 05:48:50 +02:00
Alex Godfrey
903b17b197
Docs(Start): Update environment-functions.md with correct function names (#5236)
Since the RC, serverOnly and clientOnly no longer exist, and we use
createServerOnlyFn and createClientOnlyFn. I updated the docs to reflect
that.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- New Features
- Introduced createServerOnlyFn and createClientOnlyFn helpers for
environment-bound execution.

- Documentation
- Updated guides, examples, import examples, error messages, and
tree-shaking notes to use the new helper names.

- Refactor
- Renamed public environment helpers (serverOnly → createServerOnlyFn,
clientOnly → createClientOnlyFn) and removed the old exports from the
public API.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com>
2025-09-26 00:34:58 +02:00
Jakob Norlin
e216127677
docs: update build-from-scratch replacements for SolidJS (#5216)
The docs make references to react in a lot of places. I updated the ones
I could find in the build-from-scratch guide to use proper solid-js
package names and other references.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Expanded "build from scratch" guide for migrating from React to
SolidJS.
- Added comprehensive mapping of React libraries, tooling, and plugins
to Solid equivalents.
- Documents alternative React tooling options and Solid-compatible
plugin recommendations.
- Clarifies updating JSX runtime and project configuration for SolidJS.
- Describes import/usage changes and fragment/JSX differences needed for
Solid.
  - Notes removal of React-specific type artifacts during migration.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com>
Co-authored-by: Nico Lynzaad <nlynzaad@zylangroup.com>
2025-09-26 00:31:48 +02:00
MHeinonen
ed7004b43e
docs: fix router.tsx filename in snippet (#5218) 2025-09-25 20:31:01 +02:00
Rafał Goławski
5fc1ede8be
docs(server-functions): fix unclosed markdown code block (#5226)
This fixes an unclosed Markdown code block in the `server-functions`
documentation page. Without the closing fence, the rest of the page
renders incorrectly.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Standardized code block formatting in the React Server Functions guide
by replacing four-backtick fences with standard triple backticks for
TypeScript snippets.
* Improves readability, syntax highlighting, and consistency across
examples, including route loading and basic parameter sections.
  * No changes to behavior, APIs, or functionality.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com>
2025-09-25 18:30:31 +02:00
Christoffer Bjelke
4f62cfaf1e
docs(Start): Revise migration guide for TanStack Start (#5211)
Update installation instructions and routing configurations for TanStack
Start.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated React migration guide from Next.js with current routing
conventions and defaults.
* Adjusted installation guidance to reflect updated tooling and plugin
placement.
* Clarified new project layout defaults (explicit src directory and
routes location).
  * Renamed and simplified example entry file and setup steps.
* Refreshed examples to use the new routing, link and server-function
patterns for parity with Next.js App Router.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-24 22:03:44 +02:00
Manuel Schiller
e4d5671ba9
fix: various fixes (#5215)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-24 21:42:56 +02:00
Nico Lynzaad
06839407b9
Docs(Start): remove target from hosting docs (#5204)
This removes reference to the target property from the hosting docs as
this is now defined through vite plugins
2025-09-24 10:42:11 +02:00
Nico Lynzaad
065722ab29
docs(start): fix broken links (#5197)
corrects broken links in the start docs

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Updated numerous cross‑reference links across React start guides
(authentication, execution model, server functions, environment
variables, middleware, router guides, migration) to point to correct
locations.
* Hosting guide: added a Netlify section with setup example; updated
Cloudflare Workers and Railway/Node.js anchors for clarity.
  * Authentication docs: minor formatting tweaks.
  * Server routes: removed merge conflict markers and cleaned content.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-24 03:18:36 +02:00
Manuel Schiller
70d2989546 docs: update to RC 2025-09-24 00:16:51 +02:00
Manuel Schiller
f955b5d732 docs: remove registerGlobalMiddleware 2025-09-23 23:19:09 +02:00
Tanner Linsley
0b33aa5cb4 docs: RC callout 2025-09-23 14:06:46 -06:00
Tanner Linsley
e317020ddd docs: middleware header 2025-09-23 13:46:19 -06:00
Tanner Linsley
657fe59332 docs: middleware 2025-09-23 13:43:34 -06:00
autofix-ci[bot]
29493cb5ba
ci: apply automated fixes 2025-09-23 19:35:21 +00:00
Tanner Linsley
e6475dac20 docs: Start overhaul
# Conflicts:
#	docs/start/config.json
#	docs/start/framework/react/hosting.md
#	docs/start/framework/react/learn-the-basics.md
#	docs/start/framework/react/middleware.md
#	docs/start/framework/react/overview.md
#	docs/start/framework/react/server-functions.md
#	docs/start/framework/react/server-routes.md
#	docs/start/framework/solid/build-from-scratch.md
#	docs/start/framework/solid/hosting.md
#	docs/start/framework/solid/learn-the-basics.md
#	docs/start/framework/solid/selective-ssr.md
2025-09-23 13:34:03 -06:00
autofix-ci[bot]
0a28b17b9e
ci: apply automated fixes 2025-09-23 18:14:14 +00:00
Jaime R.
8c0f8d439f
[Docs] Fix two dots in method call (#5190)
Tiny fix 😊

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Corrected middleware chaining in the React static server functions
example, replacing an erroneous double-dot with proper single-dot method
chaining.
* Example now compiles and accurately reflects the fluent API, improving
clarity for readers.
* No changes to public APIs or runtime behavior; this is a documentation
fix to prevent developer confusion.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-23 20:13:06 +02:00
Tanner Linsley
04176ecee7 docs: funded by 2025-09-23 11:45:10 -06:00
Manuel Schiller
32faee22da
feat: Start RC (#5189)
Co-authored-by: Nico Lynzaad <nlynzaad@zylangroup.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Tanner Linsley <tannerlinsley@users.noreply.github.com>
Co-authored-by: James Opstad <13586373+jamesopstad@users.noreply.github.com>
Co-authored-by: chorobin <chrishorobin@hotmail.com>
Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
Co-authored-by: Nico Lynzaad <44094871+nlynzaad@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: hokkyss <hokkyss2@gmail.com>
Co-authored-by: Philippe Serhal <philippe.serhal@gmail.com>
Co-authored-by: Jack Herrington <jherr@pobox.com>
Co-authored-by: Brenley Dueck <brenleydueck@gmail.com>
2025-09-23 11:34:54 -06:00
Shruti Kapoor
fb4c6a1b82
docs: Tutorial: Fetching data from an external API (#5050)
Adding a new tutorial to Docs -> Tutorials 

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* Documentation
* Added a step-by-step tutorial showing server-side route-loader
fetching from an external API into a TanStack Start React app (TMDB
example), covering project setup, env token usage, data flow (SSR),
loading/error states, UI samples, and testing instructions
(/fetch-movies).
* Chores
* Added a Tutorials entry linking the new guide into the React
documentation navigation.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-16 20:30:48 -06:00
Shruti Kapoor
e4a3e74a29
docs: Moving images inline and changing urls to relative (#5072)
Incorporating feedback from PR -
https://github.com/TanStack/router/pull/4089. Changes made -
1. Moved images to `assets` folder on suggestion
2. Changed URLs from absolute to relative. 
3. Adding an in-line sequence diagram

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Newly added jokes now receive unique identifiers, improving
reliability when creating new entries.

* **Documentation**
* Updated links to internal paths for SSR, router concepts, and React
Query sections.
* Switched images to repository-hosted assets for consistency and
availability.
* Replaced the data flow image with an inline Mermaid sequence diagram
covering home-page loading and add-joke flows, including data refresh
behavior.
  * Minor formatting cleanup.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-09-16 20:29:49 -06:00
autofix-ci[bot]
9a728b67b6
ci: apply automated fixes 2025-09-12 22:00:41 +00:00
Pavel Rakhmanov
ff07b8135f
docs: fix invalid JSX on selective-ssr documentation page (#5142) 2025-09-12 23:59:50 +02:00
Jakob Norlin
6202162dd3
docs: change hydration target to document.body in custom client.tsx for Solid (#5091)
Fixes #5085

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated the Solid framework “Learn the Basics” guide to correct the
client hydration example, targeting the appropriate DOM root.
* Clarifies which element to hydrate, aligning the snippet with current
best practices and reducing confusion for readers.
* Improves copy‑paste reliability of the example for newcomers following
the setup steps.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-09-05 19:07:19 -05:00
Ian J. MacIntosh
741821b2d2
docs(start): Add Railway instructions (#4910)
I was puzzled why Railway wasn't starting a server, then realized
TanStack Start doesn't define the start command by default
2025-09-04 21:49:49 -05:00
autofix-ci[bot]
df4abd267a
ci: apply automated fixes 2025-09-04 20:26:58 +00:00
Nitin Gupta
f8f47d59aa
Added Prisma as a partner in relevant places (#5086)
Inserted relevant logo files and/or blurbs re: Prisma Postgres in the
relevant places. Please review and edit as you see fit.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- Documentation
- Added a Prisma partner tile to the Partners section, linking to
prisma.io with tracking parameters and logo.
- Introduced a Prisma Postgres subsection in the React databases guide
with dark/light logos, feature highlights (edge-optimized, fits your
stack, web UI, auto-scaling, unikernel isolation), and CTAs; placed
after Neon.
- Added Prisma to the TanStack Start funded partners overview with logo
and description, positioned between Neon and Convex.
  - No functional or API changes.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
2025-09-04 14:26:10 -06:00
hokkyss
bc5e78f04c
docs(start): environment functions for createIsomorphicFn and envOnly (#4806) 2025-09-03 15:40:25 +12:00
Manuel Schiller
31783149e5 docs: document shellComponent 2025-09-02 20:55:42 +02:00
Abdullah Al-taheri
fe43f1bf53
docs: Update static-prerendering.md (#4903)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-11 01:53:44 +02:00
Adam Rackis
3023706938
Update getting-started.md (#4909)
Add TanStack Start CLI option
2025-08-10 09:14:53 -07:00
Adam Bouqdib
75615f3994
docs(start): fix cloudflare-workers deployment using wrangler.toml (#4779) 2025-08-02 13:07:49 +12:00
Sean Cassiere
7f290adb41
docs: add frontmatter to the "how-to" guides (#4835) 2025-07-30 20:04:05 +12:00
autofix-ci[bot]
87a730ba5a
ci: apply automated fixes 2025-07-29 17:57:14 +00:00
Tanner Linsley
b402bbc8ca
docs: isomorphic and environment aware code
Add foundational how-to guide on writing isomorphic, client-only, and
server-only code to clarify execution boundaries in TanStack Start.

---
<a
href="https://cursor.com/background-agent?bcId=bc-164a09a2-5b83-4a4a-b6ed-22e447950438">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-cursor-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-cursor-light.svg">
<img alt="Open in Cursor" src="https://cursor.com/open-in-cursor.svg">
  </picture>
</a>
<a
href="https://cursor.com/agents?id=bc-164a09a2-5b83-4a4a-b6ed-22e447950438">
  <picture>
<source media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/open-in-web-dark.svg">
<source media="(prefers-color-scheme: light)"
srcset="https://cursor.com/open-in-web-light.svg">
    <img alt="Open in Web" src="https://cursor.com/open-in-web.svg">
  </picture>
</a>

<sub>[Learn
more](https://docs.cursor.com/background-agent/web-and-mobile) about
Cursor Agents</sub>

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-29 11:55:46 -06:00
autofix-ci[bot]
bff3ad651d
ci: apply automated fixes 2025-07-29 00:50:17 +00:00
Tanner Linsley
c88c2aebae
docs: Outline top how-to guides for TanStack Start (#4816)
Create a detailed plan for TanStack Start how-to guides, prioritizing
based on user issues and dependencies.

This plan outlines over 20 new how-to guides, organized by logical
dependencies and explicitly addressing common pain points found in
GitHub issues, particularly around server functions and deployment.

---

[Open in
Web](https://cursor.com/agents?id=bc-58c1c95a-be49-4ad5-8bd7-80ad78fbc4e7)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-58c1c95a-be49-4ad5-8bd7-80ad78fbc4e7)
• [Open Docs](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2025-07-28 18:49:29 -06:00
autofix-ci[bot]
de11338d8c
ci: apply automated fixes 2025-07-27 17:15:24 +00:00
notKamui
a08b600b66
docs: Runtime env docs (#4797)
With discussions with @schiller-manuel and the amount of time this issue
has been brought up on Discord, I feel adding precisions and more
explicit examples on how to deal with runtime env variables on the
client could help.

---------

Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
2025-07-27 11:14:40 -06:00
Lachlan Collins
a89408affd
chore: sync TanStack repo changes (#4784)
## 🎯 Changes

- Update Prettier and use experimental CLI
- Update Nx to v21
- Fix bug in test exposed by new prettier version
- Sync issues template

## ✅ Checklist

- [x] I have followed the steps listed in the [Contributing
guide](https://github.com/TanStack/config/blob/main/CONTRIBUTING.md).
- [x] I have tested and linted this code locally.
2025-07-26 21:55:38 +10:00
Tanner Linsley
4f802cf1c0
docs: env vars (#4777)
Add a detailed plan for a new 'How to Use Environment Variables' guide
because it addresses a critical and frequently asked topic that is
currently under-documented.

---

[Open in
Web](https://cursor.com/agents?id=bc-7c882ddb-7215-41c7-9ef1-32f42f212449)
• [Open in
Cursor](https://cursor.com/background-agent?bcId=bc-7c882ddb-7215-41c7-9ef1-32f42f212449)

Learn more about [Background
Agents](https://docs.cursor.com/background-agent/web-and-mobile)

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-07-25 16:50:39 -06:00
Karthik Appiah
b38c42e753
docs(start): add missing dev dep to build-from-scratch guide (#4758) 2025-07-25 09:07:35 +12:00
Kamlesh Paul
be1b9e39b3
docs: typo in Server-Routes => Escaped Matching (#4741) 2025-07-22 17:12:30 +02:00
Usman S. (Max Programming)
132bd0c6d3
docs(start): build-from-scratch guide to use customVite(React/Solid)Plugin (#4678)
Co-authored-by: Sean Cassiere <33615041+SeanCassiere@users.noreply.github.com>
2025-07-17 23:00:02 +12:00
Ahmed Abdelbaset
1746c08918
docs(start): remove todo from Server Routes guide (#4650) 2025-07-14 22:43:26 +12:00