@tanstack/react-router 1.132.47 → 1.133.7

package/dist/llms/rules/setup-and-architecture.js

@@ -161,247 +161,375 @@ Enough overview, there's so much more to do with TanStack Router. Hit that next
 
 # Quick Start
 
-If you're feeling impatient and prefer to skip all of our wonderful documentation, here is the bare minimum to get going with TanStack Router using both file-based route generation and code-based route configuration:
+TanStack Router can be quickly added to any existing React project or used to scaffold a new one.
 
-## Using File-Based Route Generation
+## TanStack Router Installation
 
-File based route generation (through Vite, and other supported bundlers) is the recommended way to use TanStack Router as it provides the best experience, performance, and ergonomics for the least amount of effort.
+### Requirements
 
-### Scaffolding Your First TanStack Router Project
+Before installing TanStack router, please ensure your project meets the following requirements:
 
-\`\`\`sh
-npx create-tsrouter-app@latest my-app --template file-router
-\`\`\`
+[//]: # 'Requirements'
+
+- \`react\` v18 or later with \`createRoot\` support.
+- \`react-dom\` v18 or later.
+
+[//]: # 'Requirements'
 
-See [create-tsrouter-app](https://github.com/TanStack/create-tsrouter-app/tree/main/cli/create-tsrouter-app) for more options.
+> [!NOTE] Using TypeScript (\`v5.3.x or higher\`) is recommended for the best development experience, though not strictly required. We aim to support the last 5 minor versions of TypeScript, but using the latest version will help avoid potential issues.
 
-### Manual Setup
+TanStack Router is currently only compatible with React (with ReactDOM) and Solid. If you're interested in contributing to support other frameworks, such as React Native, Angular, or Vue, please reach out to us on [Discord](https://tlinz.com/discord).
 
-Alternatively, you can manually setup the project using the following steps:
+### Download and Install
 
-#### Install TanStack Router, Vite Plugin, and the Router Devtools
+To install TanStack Router in your project, run the following command using your preferred package manager:
+
+[//]: # 'installCommand'
 
 \`\`\`sh
-npm install @tanstack/react-router @tanstack/react-router-devtools
-npm install -D @tanstack/router-plugin
-# or
-pnpm add @tanstack/react-router @tanstack/react-router-devtools
-pnpm add -D @tanstack/router-plugin
+npm install @tanstack/react-router
 # or
-yarn add @tanstack/react-router @tanstack/react-router-devtools
-yarn add -D @tanstack/router-plugin
+pnpm add @tanstack/react-router
+#or
+yarn add @tanstack/react-router
 # or
-bun add @tanstack/react-router @tanstack/react-router-devtools
-bun add -D @tanstack/router-plugin
+bun add @tanstack/react-router
 # or
-deno add npm:@tanstack/react-router npm:@tanstack/router-plugin npm:@tanstack/react-router-devtools
+deno add npm:@tanstack/react-router
 \`\`\`
 
-#### Configure the Vite Plugin
+[//]: # 'installCommand'
 
-\`\`\`tsx
-// vite.config.ts
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
-import { tanstackRouter } from '@tanstack/router-plugin/vite'
-
-// https://vitejs.dev/config/
-export default defineConfig({
-  plugins: [
-    // Please make sure that '@tanstack/router-plugin' is passed before '@vitejs/plugin-react'
-    tanstackRouter({
-      target: 'react',
-      autoCodeSplitting: true,
-    }),
-    react(),
-    // ...,
-  ],
-})
+Once installed, you can verify the installation by checking your \`package.json\` file for the dependency.
+
+[//]: # 'packageJson'
+
+\`\`\`json
+{
+  "dependencies": {
+    "@tanstack/react-router": "^x.x.x"
+  }
+}
 \`\`\`
 
-> [!TIP]
-> If you are not using Vite, or any of the supported bundlers, you can check out the [TanStack Router CLI](../routing/installation-with-router-cli.md) guide for more info.
+[//]: # 'packageJson'
 
-Create the following files:
+## New Project Setup
 
-- \`src/routes/__root.tsx\` (with two '\`_\`' characters)
-- \`src/routes/index.tsx\`
-- \`src/routes/about.tsx\`
-- \`src/main.tsx\`
+To quickly scaffold a new project with TanStack Router, you can use the \`create-tsrouter-app\` command-line tool. This tool sets up a new React application with TanStack Router pre-configured, allowing you to get started quickly.
 
-#### \`src/routes/__root.tsx\`
+> [!TIP] For full details on available options and templates, visit the [\`create-tsrouter-app\` documentation](https://github.com/TanStack/create-tsrouter-app/tree/main/cli/create-tsrouter-app).
 
-\`\`\`tsx
-import { createRootRoute, Link, Outlet } from '@tanstack/react-router'
-import { TanStackRouterDevtools } from '@tanstack/react-router-devtools'
+To create a new project, run the following command in your terminal:
 
-const RootLayout = () => (
-  <>
-    <div className="p-2 flex gap-2">
-      <Link to="/" className="[&.active]:font-bold">
-        Home
-      </Link>{' '}
-      <Link to="/about" className="[&.active]:font-bold">
-        About
-      </Link>
-    </div>
-    <hr />
-    <Outlet />
-    <TanStackRouterDevtools />
-  </>
-)
+[//]: # 'createAppCommand'
 
-export const Route = createRootRoute({ component: RootLayout })
+\`\`\`sh
+npx create-tsrouter-app@latest
 \`\`\`
 
-#### \`src/routes/index.tsx\`
+[//]: # 'createAppCommand'
 
-\`\`\`tsx
-import { createFileRoute } from '@tanstack/react-router'
+The CLI will guide you through a short series of prompts to customize your setup, including options for:
 
-export const Route = createFileRoute('/')({
-  component: Index,
-})
+[//]: # 'CLIPrompts'
+
+- File-based or code-based route configuration
+- TypeScript support
+- Tailwind CSS integration
+- Toolchain setup
+- Git initialization
+
+[//]: # 'CLIPrompts'
+
+Once complete, a new React project will be generated with TanStack Router installed and ready to use. All dependencies are automatically installed, so you can jump straight into development:
+
+\`\`\`sh
+cd your-project-name
+npm run dev
+\`\`\`
+
+### Routing Options
+
+TanStack Router supports both file-based and code-based route configurations, allowing you to choose the approach that best fits your workflow.
+
+#### File-Based Route Generation
+
+The file-based approach is the recommended option for most projects. It automatically creates routes based on your file structure, giving you the best mix of performance, simplicity, and developer experience.
+
+To create a new project using file-based route generation, run the following command:
+
+[//]: # 'createAppCommandFileBased'
+
+\`\`\`sh
+npx create-tsrouter-app@latest my-app --template file-router
+\`\`\`
+
+[//]: # 'createAppCommandFileBased'
+
+This command sets up a new directory called \`my-app\` with everything configured. Once setup completes, you can then start your development server and begin building your application:
+
+\`\`\`sh
+cd my-app
+npm run dev
+\`\`\`
+
+#### Code-Based Route Configuration
+
+If you prefer to define routes programmatically, you can use the code-based route configuration. This approach gives you full control over routing logic while maintaining the same project scaffolding workflow.
+
+[//]: # 'createAppCommandCodeBased'
+
+\`\`\`sh
+npx create-tsrouter-app@latest my-app
+\`\`\`
+
+[//]: # 'createAppCommandCodeBased'
+
+Similar to the file-based setup, this command creates a new directory called \`my-app\` with TanStack Router configured for code-based routing. After setup, navigate to your project directory and start the development server:
+
+\`\`\`sh
+cd my-app
+npm run dev
+\`\`\`
+
+With either approach, you can now start building your React application with TanStack Router!
+
+# Decisions on Developer Experience
+
+When people first start using TanStack Router, they often have a lot of questions that revolve around the following themes:
+
+> Why do I have to do things this way?
+
+> Why is it done this way? and not that way?
+
+> I'm used to doing it this way, why should I change?
+
+And they are all valid questions. For the most part, people are used to using routing libraries that are very similar to each other. They all have a similar API, similar concepts, and similar ways of doing things.
+
+But TanStack Router is different. It's not your average routing library. It's not your average state management library. It's not your average anything.
+
+## TanStack Router's origin story
+
+It's important to remember that TanStack Router's origins stem from [Nozzle.io](https://nozzle.io)'s need for a client-side routing solution that offered a first-in-class _URL Search Parameters_ experience without compromising on the **_type-safety_** that was required to power its complex dashboards.
+
+And so, from TanStack Router's very inception, every facet of its design was meticulously thought out to ensure that its type-safety and developer experience were second to none.
+
+## How does TanStack Router achieve this?
+
+> TypeScript! TypeScript! TypeScript!
+
+Every aspect of TanStack Router is designed to be as type-safe as possible, and this is achieved by leveraging TypeScript's type system to its fullest extent. This involves using some very advanced and complex types, type inference, and other features to ensure that the developer experience is as smooth as possible.
+
+But to achieve this, we had to make some decisions that deviate from the norms in the routing world.
+
+1. [**Route configuration boilerplate?**](#1-why-is-the-routers-configuration-done-this-way): You have to define your routes in a way that allows TypeScript to infer the types of your routes as much as possible.
+2. [**TypeScript module declaration for the router?**](#2-declaring-the-router-instance-for-type-inference): You have to pass the \`Router\` instance to the rest of your application using TypeScript's module declaration.
+3. [**Why push for file-based routing over code-based?**](#3-why-is-file-based-routing-the-preferred-way-to-define-routes): We push for file-based routing as the preferred way to define your routes.
+
+> TLDR; All the design decisions in the developer experience of using TanStack Router are made so that you can have a best-in-class type-safety experience without compromising on the control, flexibility, and maintainability of your route configurations.
+
+## 1. Why is the Router's configuration done this way?
 
-function Index() {
+When you want to leverage the TypeScript's inference features to its fullest, you'll quickly realize that _Generics_ are your best friend. And so, TanStack Router uses Generics everywhere to ensure that the types of your routes are inferred as much as possible.
+
+This means that you have to define your routes in a way that allows TypeScript to infer the types of your routes as much as possible.
+
+> Can I use JSX to define my routes?
+
+Using JSX for defining your routes is **out of the question**, as TypeScript will not be able to infer the route configuration types of your router.
+
+\`\`\`tsx
+// ⛔️ This is not possible
+function App() {
   return (
-    <div className="p-2">
-      <h3>Welcome Home!</h3>
-    </div>
+    <Router>
+      <Route path="/posts" component={PostsPage} />
+      <Route path="/posts/$postId" component={PostIdPage} />
+      {/* ... */}
+    </Router>
+    // ^? TypeScript cannot infer the routes in this configuration
   )
 }
 \`\`\`
 
-#### \`src/routes/about.tsx\`
+And since this would mean that you'd have to manually type the \`to\` prop of the \`<Link>\` component and wouldn't catch any errors until runtime, it's not a viable option.
 
-\`\`\`tsx
-import { createFileRoute } from '@tanstack/react-router'
+> Maybe I could define my routes as a tree of nested objects?
 
-export const Route = createFileRoute('/about')({
-  component: About,
+\`\`\`tsx
+// ⛔️ This file will just keep growing and growing...
+const router = createRouter({
+  routes: {
+    posts: {
+      component: PostsPage, // /posts
+      children: {
+        $postId: {
+          component: PostIdPage, // /posts/$postId
+        },
+      },
+    },
+    // ...
+  },
 })
-
-function About() {
-  return <div className="p-2">Hello from About!</div>
-}
 \`\`\`
 
-#### \`src/main.tsx\`
+At first glance, this seems like a good idea. It's easy to visualize the entire route hierarchy in one go. But this approach has a couple of big downsides that make it not ideal for large applications:
+
+- **It's not very scalable**: As your application grows, the tree will grow and become harder to manage. And since it's all defined in one file, it can become very hard to maintain.
+- **It's not great for code-splitting**: You'd have to manually code-split each component and then pass it into the \`component\` property of the route, further complicating the route configuration with an ever-growing route configuration file.
+
+This only gets worse as you begin to use more features of the router, such as nested context, loaders, search param validation, etc.
+
+> So, what's the best way to define my routes?
+
+What we found to be the best way to define your routes is to abstract the definition of the route configuration outside of the route-tree. Then stitch together your route configurations into a single cohesive route-tree that is then passed into the \`createRouter\` function.
 
-Regardless of whether you are using the \`@tanstack/router-plugin\` package and running the \`npm run dev\`/\`npm run build\` scripts, or manually running the \`tsr watch\`/\`tsr generate\` commands from your package scripts, the route tree file will be generated at \`src/routeTree.gen.ts\`.
+You can read more about [code-based routing](../routing/code-based-routing.md) to see how to define your routes in this way.
 
-Import the generated route tree and create a new router instance:
+> [!TIP]
+> Finding Code-based routing to be a bit too cumbersome? See why [file-based routing](#3-why-is-file-based-routing-the-preferred-way-to-define-routes) is the preferred way to define your routes.
+
+## 2. Declaring the Router instance for type inference
+
+> Why do I have to declare the \`Router\`?
+
+> This declaration stuff is way too complicated for me...
+
+Once you've constructed your routes into a tree and passed it into your Router instance (using \`createRouter\`) with all the generics working correctly, you then need to somehow pass this information to the rest of your application.
+
+There were two approaches we considered for this:
+
+1. **Imports**: You could import the \`Router\` instance from the file where you created it and use it directly in your components.
 
 \`\`\`tsx
-import { StrictMode } from 'react'
-import ReactDOM from 'react-dom/client'
-import { RouterProvider, createRouter } from '@tanstack/react-router'
+import { router } from '@/src/app'
+export const PostsIdLink = () => {
+  return (
+    <Link<typeof router> to="/posts/$postId" params={{ postId: '123' }}>
+      Go to post 123
+    </Link>
+  )
+}
+\`\`\`
+
+A downside to this approach is that you'd have to import the entire \`Router\` instance into every file where you want to use it. This can lead to increased bundle sizes and can be cumbersome to manage, and only get worse as your application grows and you use more features of the router.
 
-// Import the generated route tree
-import { routeTree } from './routeTree.gen'
+2. **Module declaration**: You can use TypeScript's module declaration to declare the \`Router\` instance as a module that can be used for type inference anywhere in your application without having to import it.
 
-// Create a new router instance
-const router = createRouter({ routeTree })
+You'll do this once in your application.
 
-// Register the router instance for type safety
+\`\`\`tsx
+// src/app.tsx
 declare module '@tanstack/react-router' {
   interface Register {
     router: typeof router
   }
 }
+\`\`\`
 
-// Render the app
-const rootElement = document.getElementById('root')!
-if (!rootElement.innerHTML) {
-  const root = ReactDOM.createRoot(rootElement)
-  root.render(
-    <StrictMode>
-      <RouterProvider router={router} />
-    </StrictMode>,
+And then you can benefit from its auto-complete anywhere in your app without having to import it.
+
+\`\`\`tsx
+export const PostsIdLink = () => {
+  return (
+    <Link
+      to="/posts/$postId"
+      // ^? TypeScript will auto-complete this for you
+      params={{ postId: '123' }} // and this too!
+    >
+      Go to post 123
+    </Link>
   )
 }
 \`\`\`
 
-If you are working with this pattern you should change the \`id\` of the root \`<div>\` on your \`index.html\` file to \`<div id='root'></div>\`
+We went with **module declaration**, as it is what we found to be the most scalable and maintainable approach with the least amount of overhead and boilerplate.
 
-## Using Code-Based Route Configuration
+## 3. Why is file-based routing the preferred way to define routes?
 
-> [!IMPORTANT]
-> The following example shows how to configure routes using code, and for simplicity's sake is in a single file for this demo. While code-based generation allows you to declare many routes and even the router instance in a single file, we recommend splitting your routes into separate files for better organization and performance as your application grows.
+> Why are the docs pushing for file-based routing?
+
+> I'm used to defining my routes in a single file, why should I change?
+
+Something you'll notice (quite soon) in the TanStack Router documentation is that we push for **file-based routing** as the preferred method for defining your routes. This is because we've found that file-based routing is the most scalable and maintainable way to define your routes.
+
+> [!TIP]
+> Before you continue, it's important you have a good understanding of [code-based routing](../routing/code-based-routing.md) and [file-based routing](../routing/file-based-routing.md).
+
+As mentioned in the beginning, TanStack Router was designed for complex applications that require a high degree of type-safety and maintainability. And to achieve this, the configuration of the router has been done in a precise way that allows TypeScript to infer the types of your routes as much as possible.
+
+A key difference in the set-up of a _basic_ application with TanStack Router, is that your route configurations require a function to be provided to \`getParentRoute\`, that returns the parent route of the current route.
 
 \`\`\`tsx
-import { StrictMode } from 'react'
-import ReactDOM from 'react-dom/client'
-import {
-  Outlet,
-  RouterProvider,
-  Link,
-  createRouter,
-  createRoute,
-  createRootRoute,
-} from '@tanstack/react-router'
-import { TanStackRouterDevtools } from '@tanstack/react-router-devtools'
+import { createRoute } from '@tanstack/react-router'
+import { postsRoute } from './postsRoute'
 
-const rootRoute = createRootRoute({
-  component: () => (
-    <>
-      <div className="p-2 flex gap-2">
-        <Link to="/" className="[&.active]:font-bold">
-          Home
-        </Link>{' '}
-        <Link to="/about" className="[&.active]:font-bold">
-          About
-        </Link>
-      </div>
-      <hr />
-      <Outlet />
-      <TanStackRouterDevtools />
-    </>
-  ),
+export const postsIndexRoute = createRoute({
+  getParentRoute: () => postsRoute,
+  path: '/',
 })
+\`\`\`
+
+At this stage, this is done so the definition of \`postsIndexRoute\` can be aware of its location in the route tree and so that it can correctly infer the types of the \`context\`, \`path params\`, \`search params\` returned by the parent route. Incorrectly defining the \`getParentRoute\` function means that the properties of the parent route will not be correctly inferred by the child route.
+
+As such, this is a critical part of the route configuration and a point of failure if not done correctly.
 
-const indexRoute = createRoute({
-  getParentRoute: () => rootRoute,
+But this is only one part of setting up a basic application. TanStack Router requires all the routes (including the root route) to be stitched into a **_route-tree_** so that it may be passed into the \`createRouter\` function before declaring the \`Router\` instance on the module for type inference. This is another critical part of the route configuration and a point of failure if not done correctly.
+
+> 🤯 If this route-tree were in its own file for an application with ~40-50 routes, it can easily grow up to 700+ lines.
+
+\`\`\`tsx
+const routeTree = rootRoute.addChildren([
+  postsRoute.addChildren([postsIndexRoute, postsIdRoute]),
+])
+\`\`\`
+
+This complexity only increases as you begin to use more features of the router, such as nested context, loaders, search param validation, etc. As such, it no longer becomes feasible to define your routes in a single file. And so, users end up building their own _semi consistent_ way of defining their routes across multiple files. This can lead to inconsistencies and errors in the route configuration.
+
+Finally, comes the issue of code-splitting. As your application grows, you'll want to code-split your components to reduce the initial bundle size of your application. This can be a bit of a headache to manage when you're defining your routes in a single file or even across multiple files.
+
+\`\`\`tsx
+import { createRoute, lazyRouteComponent } from '@tanstack/react-router'
+import { postsRoute } from './postsRoute'
+
+export const postsIndexRoute = createRoute({
+  getParentRoute: () => postsRoute,
   path: '/',
-  component: function Index() {
-    return (
-      <div className="p-2">
-        <h3>Welcome Home!</h3>
-      </div>
-    )
-  },
+  component: lazyRouteComponent(() => import('../page-components/posts/index')),
 })
+\`\`\`
 
-const aboutRoute = createRoute({
-  getParentRoute: () => rootRoute,
-  path: '/about',
-  component: function About() {
-    return <div className="p-2">Hello from About!</div>
-  },
-})
+All of this boilerplate, no matter how essential for providing a best-in-class type-inference experience, can be a bit overwhelming and can lead to inconsistencies and errors in the route configuration.
 
-const routeTree = rootRoute.addChildren([indexRoute, aboutRoute])
+... and this example configuration is just for rendering a single codes-split route. Imagine having to do this for 40-50 routes. Now remember that you still haven't touched the \`context\`, \`loaders\`, \`search param validation\`, and other features of the router 🤕.
 
-const router = createRouter({ routeTree })
+> So, why's file-based routing the preferred way?
 
-declare module '@tanstack/react-router' {
-  interface Register {
-    router: typeof router
-  }
-}
+TanStack Router's file-based routing is designed to solve all of these issues. It allows you to define your routes in a predictable way that is easy to manage and maintain, and is scalable as your application grows.
 
-const rootElement = document.getElementById('app')!
-if (!rootElement.innerHTML) {
-  const root = ReactDOM.createRoot(rootElement)
-  root.render(
-    <StrictMode>
-      <RouterProvider router={router} />
-    </StrictMode>,
-  )
-}
+The file-based routing approach is powered by the TanStack Router Bundler Plugin. It performs 3 essential tasks that solve the pain points in route configuration when using code-based routing:
+
+1. **Route configuration boilerplate**: It generates the boilerplate for your route configurations.
+2. **Route tree stitching**: It stitches together your route configurations into a single cohesive route-tree. Also in the background, it correctly updates the route configurations to define the \`getParentRoute\` function match the routes with their parent routes.
+3. **Code-splitting**: It automatically code-splits your route content components and updates the route configurations with the correct component. Additionally, at runtime, it ensures that the correct component is loaded when the route is visited.
+
+Let's take a look at how the route configuration for the previous example would look like with file-based routing.
+
+\`\`\`tsx
+// src/routes/posts/index.ts
+import { createFileRoute } from '@tanstack/react-router'
+
+export const Route = createFileRoute('/posts/')({
+  component: () => 'Posts index component goes here!!!',
+})
 \`\`\`
 
-If you glossed over these examples or didn't understand something, we don't blame you, because there's so much more to learn to really take advantage of TanStack Router! Let's move on.
+That's it! No need to worry about defining the \`getParentRoute\` function, stitching together the route-tree, or code-splitting your components. The TanStack Router Bundler Plugin handles all of this for you.
+
+At no point does the TanStack Router Bundler Plugin take away your control over your route configurations. It's designed to be as flexible as possible, allowing you to define your routes in a way that suits your application whilst reducing the boilerplate and complexity of the route configuration.
+
+Check out the guides for [file-based routing](../routing/file-based-routing.md) and [code-splitting](../guide/code-splitting.md) for a more in-depth explanation of how they work in TanStack Router.
 
 # Devtools
 
@@ -593,307 +721,23 @@ function App() {
   - Specifies a Shadow DOM target for the devtools.
   - By default, devtool styles are applied to the \`<head>\` tag of the main document (light DOM). When a \`shadowDOMTarget\` is provided, styles will be applied within this Shadow DOM instead.
 
-# Migration from React Router Checklist
-
-**_If your UI is blank, open the console, and you will probably have some errors that read something along the lines of \`cannot use 'useNavigate' outside of context\` . This means there are React Router api’s that are still imported and referenced that you need to find and remove. The easiest way to make sure you find all React Router imports is to uninstall \`react-router-dom\` and then you should get typescript errors in your files. Then you will know what to change to a \`@tanstack/react-router\` import._**
-
-Here is the [example repo](https://github.com/Benanna2019/SickFitsForEveryone/tree/migrate-to-tanstack/router/React-Router)
-
-- [ ] Install Router - \`npm i @tanstack/react-router\` (see [detailed installation guide](../how-to/install.md))
-- [ ] **Optional:** Uninstall React Router to get TypeScript errors on imports.
-  - At this point I don’t know if you can do a gradual migration, but it seems likely you could have multiple router providers, not desirable.
-  - The api’s between React Router and TanStack Router are very similar and could most likely be handled in a sprint cycle or two if that is your companies way of doing things.
-- [ ] Create Routes for each existing React Router route we have
-- [ ] Create root route
-- [ ] Create router instance
-- [ ] Add global module in main.tsx
-- [ ] Remove any React Router (\`createBrowserRouter\` or \`BrowserRouter\`), \`Routes\`, and \`Route\` Components from main.tsx
-- [ ] **Optional:** Refactor \`render\` function for custom setup/providers - The repo referenced above has an example - This was necessary in the case of Supertokens. Supertoken has a specific setup with React Router and a different setup with all other React implementations
-- [ ] Set RouterProvider and pass it the router as the prop
-- [ ] Replace all instances of React Router \`Link\` component with \`@tanstack/react-router\` \`Link\` component
-  - [ ] Add \`to\` prop with literal path
-  - [ ] Add \`params\` prop, where necessary with params like so \`params={{ orderId: order.id }}\`
-- [ ] Replace all instances of React Router \`useNavigate\` hook with \`@tanstack/react-router\` \`useNavigate\` hook
-  - [ ] Set \`to\` property and \`params\` property where needed
-- [ ] Replace any React Router \`Outlet\`'s with the \`@tanstack/react-router\` equivalent
-- [ ] If you are using \`useSearchParams\` hook from React Router, move the search params default value to the validateSearch property on a Route definition.
-  - [ ] Instead of using the \`useSearchParams\` hook, use \`@tanstack/react-router\` \`Link\`'s search property to update the search params state
-  - [ ] To read search params you can do something like the following
-    - \`const { page } = useSearch({ from: productPage.fullPath })\`
-- [ ] If using React Router’s \`useParams\` hook, update the import to be from \`@tanstack/react-router\` and set the \`from\` property to the literal path name where you want to read the params object from
-  - So say we have a route with the path name \`orders/$orderid\`.
-  - In the \`useParams\` hook we would set up our hook like so: \`const params = useParams({ from: "/orders/$orderId" })\`
-  - Then wherever we wanted to access the order id we would get it off of the params object \`params.orderId\`
-
-# Migration from React Location
-
-Before you begin your journey in migrating from React Location, it's important that you have a good understanding of the [Routing Concepts](../routing/routing-concepts.md) and [Design Decisions](../decisions-on-dx.md) used by TanStack Router.
-
-## Differences between React Location and TanStack Router
-
-React Location and TanStack Router share much of same design decisions concepts, but there are some key differences that you should be aware of.
-
-- React Location uses _generics_ to infer types for routes, while TanStack Router uses _module declaration merging_ to infer types.
-- Route configuration in React Location is done using a single array of route definitions, while in TanStack Router, route configuration is done using a tree of route definitions starting with the [root route](../routing/routing-concepts.md#the-root-route).
-- [File-based routing](../routing/file-based-routing.md) is the recommended way to define routes in TanStack Router, while React Location only allows you to define routes in a single file using a code-based approach.
-  - TanStack Router does support a [code-based approach](../routing/code-based-routing.md) to defining routes, but it is not recommended for most use cases. You can read more about why, over here: [why is file-based routing the preferred way to define routes?](../decisions-on-dx.md#3-why-is-file-based-routing-the-preferred-way-to-define-routes)
-
-## Migration guide
-
-In this guide we'll go over the process of migrating the [React Location Basic example](https://github.com/TanStack/router/tree/react-location/examples/basic) over to TanStack Router using file-based routing, with the end goal of having the same functionality as the original example (styling and other non-routing related code will be omitted).
-
-> [!TIP]
-> To use a code-based approach for defining your routes, you can read the [code-based Routing](../routing/code-based-routing.md) guide.
-
-### Step 1: Swap over to TanStack Router's dependencies
-
-First, we need to install the dependencies for TanStack Router. For detailed installation instructions, see our [How to Install TanStack Router](../how-to/install.md) guide.
-
-\`\`\`sh
-npm install @tanstack/react-router @tanstack/router-devtools
-\`\`\`
-
-And remove the React Location dependencies.
-
-\`\`\`sh
-npm uninstall @tanstack/react-location @tanstack/react-location-devtools
-\`\`\`
-
-### Step 2: Use the file-based routing watcher
-
-If your project uses Vite (or one of the supported bundlers), you can use the TanStack Router plugin to watch for changes in your routes files and automatically update the routes configuration.
-
-Installation of the Vite plugin:
-
-\`\`\`sh
-npm install -D @tanstack/router-plugin
-\`\`\`
-
-And add it to your \`vite.config.js\`:
-
-\`\`\`js
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
-import { tanstackRouter } from '@tanstack/router-plugin/vite'
-
-export default defineConfig({
-  // ...
-  plugins: [tanstackRouter(), react()],
-})
-\`\`\`
-
-However, if your application does not use Vite, you use one of our other [supported bundlers](../routing/file-based-routing.md#getting-started-with-file-based-routing), or you can use the \`@tanstack/router-cli\` package to watch for changes in your routes files and automatically update the routes configuration.
-
-### Step 3: Add the file-based configuration file to your project
-
-Create a \`tsr.config.json\` file in the root of your project with the following content:
-
-\`\`\`json
-{
-  "routesDirectory": "./src/routes",
-  "generatedRouteTree": "./src/routeTree.gen.ts"
-}
-\`\`\`
-
-You can find the full list of options for the \`tsr.config.json\` file [here](../../../api/file-based-routing.md).
-
-### Step 4: Create the routes directory
-
-Create a \`routes\` directory in the \`src\` directory of your project.
-
-\`\`\`sh
-mkdir src/routes
-\`\`\`
-
-### Step 5: Create the root route file
-
-\`\`\`tsx
-// src/routes/__root.tsx
-import { createRootRoute, Outlet, Link } from '@tanstack/react-router'
-import { TanStackRouterDevtools } from '@tanstack/router-devtools'
-
-export const Route = createRootRoute({
-  component: () => {
-    return (
-      <>
-        <div>
-          <Link to="/" activeOptions={{ exact: true }}>
-            Home
-          </Link>
-          <Link to="/posts">Posts</Link>
-        </div>
-        <hr />
-        <Outlet />
-        <TanStackRouterDevtools />
-      </>
-    )
-  },
-})
-\`\`\`
-
-### Step 6: Create the index route file
-
-\`\`\`tsx
-// src/routes/index.tsx
-import { createFileRoute } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/')({
-  component: Index,
-})
-\`\`\`
-
-> You will need to move any related components and logic needed for the index route from the \`src/index.tsx\` file to the \`src/routes/index.tsx\` file.
-
-### Step 7: Create the posts route file
-
-\`\`\`tsx
-// src/routes/posts.tsx
-import { createFileRoute, Link, Outlet } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/posts')({
-  component: Posts,
-  loader: async () => {
-    const posts = await fetchPosts()
-    return {
-      posts,
-    }
-  },
-})
-
-function Posts() {
-  const { posts } = Route.useLoaderData()
-  return (
-    <div>
-      <nav>
-        {posts.map((post) => (
-          <Link
-            key={post.id}
-            to={\`/posts/$postId\`}
-            params={{ postId: post.id }}
-          >
-            {post.title}
-          </Link>
-        ))}
-      </nav>
-      <Outlet />
-    </div>
-  )
-}
-\`\`\`
-
-> You will need to move any related components and logic needed for the posts route from the \`src/index.tsx\` file to the \`src/routes/posts.tsx\` file.
-
-### Step 8: Create the posts index route file
-
-\`\`\`tsx
-// src/routes/posts.index.tsx
-import { createFileRoute } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/posts/')({
-  component: PostsIndex,
-})
-\`\`\`
-
-> You will need to move any related components and logic needed for the posts index route from the \`src/index.tsx\` file to the \`src/routes/posts.index.tsx\` file.
-
-### Step 9: Create the posts id route file
-
-\`\`\`tsx
-// src/routes/posts.$postId.tsx
-import { createFileRoute } from '@tanstack/react-router'
-
-export const Route = createFileRoute('/posts/$postId')({
-  component: PostsId,
-  loader: async ({ params: { postId } }) => {
-    const post = await fetchPost(postId)
-    return {
-      post,
-    }
-  },
-})
-
-function PostsId() {
-  const { post } = Route.useLoaderData()
-  // ...
-}
-\`\`\`
-
-> You will need to move any related components and logic needed for the posts id route from the \`src/index.tsx\` file to the \`src/routes/posts.$postId.tsx\` file.
-
-### Step 10: Generate the route tree
-
-If you are using one of the supported bundlers, the route tree will be generated automatically when you run the dev script.
-
-If you are not using one of the supported bundlers, you can generate the route tree by running the following command:
-
-\`\`\`sh
-npx tsr generate
-\`\`\`
-
-### Step 11: Update the main entry file to render the Router
-
-Once you've generated the route-tree, you can then update the \`src/index.tsx\` file to create the router instance and render it.
-
-\`\`\`tsx
-// src/index.tsx
-import React from 'react'
-import ReactDOM from 'react-dom'
-import { createRouter, RouterProvider } from '@tanstack/react-router'
-
-// Import the generated route tree
-import { routeTree } from './routeTree.gen'
-
-// Create a new router instance
-const router = createRouter({ routeTree })
-
-// Register the router instance for type safety
-declare module '@tanstack/react-router' {
-  interface Register {
-    router: typeof router
-  }
-}
-
-const domElementId = 'root' // Assuming you have a root element with the id 'root'
-
-// Render the app
-const rootElement = document.getElementById(domElementId)
-if (!rootElement) {
-  throw new Error(\`Element with id \${domElementId} not found\`)
-}
-
-ReactDOM.createRoot(rootElement).render(
-  <React.StrictMode>
-    <RouterProvider router={router} />
-  </React.StrictMode>,
-)
-\`\`\`
-
-### Finished!
-
-You should now have successfully migrated your application from React Location to TanStack Router using file-based routing.
+# Frequently Asked Questions
 
-React Location also has a few more features that you might be using in your application. Here are some guides to help you migrate those features:
+Welcome to the TanStack Router FAQ! Here you'll find answers to common questions about the TanStack Router. If you have a question that isn't answered here, please feel free to ask in the [TanStack Discord](https://tlinz.com/discord).
 
-- [Search params](../guide/search-params.md)
-- [Data loading](../guide/data-loading.md)
-- [History types](../guide/history-types.md)
-- [Wildcard / Splat / Catch-all routes](../routing/routing-concepts.md#splat--catch-all-routes)
-- [Authenticated routes](../guide/authenticated-routes.md)
+## Why should you choose TanStack Router over another router?
 
-TanStack Router also has a few more features that you might want to explore:
+To answer this question, it's important to view the other options in the space. There are many alternatives to choose from, but only a couple that are widely adopted and actively maintained:
 
-- [Router Context](../guide/router-context.md)
-- [Preloading](../guide/preloading.md)
-- [Pathless Layout Routes](../routing/routing-concepts.md#pathless-layout-routes)
-- [Route masking](../guide/route-masking.md)
-- [SSR](../guide/ssr.md)
-- ... and more!
+- **Next.js** - Widely regarded as the leading framework for starting new React projects. Its design focuses on performance, development workflows, and cutting-edge technology. The framework's APIs and abstractions, while powerful, can sometimes present as non-standard. Rapid growth and industry adoption have resulted in a feature-rich experience, sometimes leading to a steeper learning curve and increased overhead.
+- **Remix / React Router** - Based on the historically successful React Router, Remix delivers a powerful developer and user experience. Its API and architectural vision are firmly rooted in web standards such as Request/Response, with an emphasis on adaptability across various JavaScript environments. Many of its APIs and abstractions are well-designed and have influenced more than a few of TanStack Router's APIs. However, its rigid design, the integration of type safety as an add-on, and sometimes strict adherence to platform APIs can present limitations for some developers.
 
-If you are facing any issues or have any questions, feel free to ask for help in the TanStack Discord.
+These frameworks and routers have their strengths, but they also come with trade-offs that may not align with every project's needs. TanStack Router aims to strike a balance by offering routing APIs designed to improve the developer experience without sacrificing flexibility or performance.
 
-# Frequently Asked Questions
+## Is TanStack Router a framework?
 
-Welcome to the TanStack Router FAQ! Here you'll find answers to common questions about the TanStack Router. If you have a question that isn't answered here, please feel free to ask in the [TanStack Discord](https://tlinz.com/discord).
+TanStack Router itself is not a "framework" in the traditional sense, since it doesn't address a few other common full-stack concerns. However, TanStack Router has been designed to be upgradable to a full-stack framework when used in conjunction with other tools that address bundling, deployments, and server-side-specific functionality. This is why we are currently developing [TanStack Start](https://tanstack.com/start), a full-stack framework that is built on top of TanStack Router and Vite.
+For a deeper dive on the history of TanStack Router, feel free to read [TanStack Router's History](../decisions-on-dx.md#tanstack-routers-origin-story).
 
 ## Should I commit my \`routeTree.gen.ts\` file into git?