Skip to content

Commit 88c15d9

Browse files
committed
docs: fixup links to guides from api reference
1 parent 31116b7 commit 88c15d9

16 files changed

Lines changed: 22 additions & 22 deletions

docs/router/api/router/LinkOptionsType.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The `LinkOptions` object accepts/contains the following properties:
3636
- Type: `false | 'intent' | 'viewport' | 'render'`
3737
- Optional
3838
- If set, the link's preloading strategy will be set to this value.
39-
- See the [Preloading guide](../../framework/react/guide/preloading.md) for more information.
39+
- See the [Preloading guide](../../guide/preloading.md) for more information.
4040
4141
### `preloadDelay`
4242

docs/router/api/router/NotFoundRouteClass.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: NotFoundRoute class
66
> [!CAUTION]
77
> This class has been deprecated and will be removed in the next major version of TanStack Router.
88
> Please use the `notFoundComponent` route option that is present during route configuration.
9-
> See the [Not Found Errors guide](../../framework/react/guide/not-found-errors.md) for more information.
9+
> See the [Not Found Errors guide](../../guide/not-found-errors.md) for more information.
1010
1111
The `NotFoundRoute` class extends the `Route` class and can be used to create a not found route instance. A not found route instance can be passed to the `routerOptions.notFoundRoute` option to configure a default not-found/404 route for every branch of the route tree.
1212

docs/router/api/router/RouteApiType.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The `RouteApi` has the following properties and methods:
2727
- Optional
2828
- `boolean`
2929
- Configures whether structural sharing is enabled for the value returned by `select`.
30-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
30+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
3131
- Returns
3232
- If a `select` function is provided, the return value of the `select` function.
3333
- If no `select` function is provided, the `RouteMatch` object or a loosened version of the `RouteMatch` object if `opts.strict` is `false`.
@@ -68,7 +68,7 @@ The `RouteApi` has the following properties and methods:
6868
- Optional
6969
- `boolean`
7070
- Configures whether structural sharing is enabled for the value returned by `select`.
71-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
71+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
7272
- Returns
7373
- If a `select` function is provided, the return value of the `select` function.
7474
- If no `select` function is provided, the `TFullSearchSchema` object or a loosened version of the `TFullSearchSchema` object if `opts.strict` is `false`.
@@ -91,7 +91,7 @@ The `RouteApi` has the following properties and methods:
9191
- Optional
9292
- `boolean`
9393
- Configures whether structural sharing is enabled for the value returned by `select`.
94-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
94+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
9595
- Returns
9696
- If a `select` function is provided, the return value of the `select` function.
9797
- If no `select` function is provided, the `TAllParams` object or a loosened version of the `TAllParams` object if `opts.strict` is `false`.
@@ -114,7 +114,7 @@ The `RouteApi` has the following properties and methods:
114114
- Optional
115115
- `boolean`
116116
- Configures whether structural sharing is enabled for the value returned by `select`.
117-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
117+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
118118
- Returns
119119
- If a `select` function is provided, the return value of the `select` function.
120120
- If no `select` function is provided, the `TLoaderData` object or a loosened version of the `TLoaderData` object if `opts.strict` is `false`.
@@ -137,7 +137,7 @@ The `RouteApi` has the following properties and methods:
137137
- Optional
138138
- `boolean`
139139
- Configures whether structural sharing is enabled for the value returned by `select`.
140-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
140+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
141141
- Returns
142142
- If a `select` function is provided, the return value of the `select` function.
143143
- If no `select` function is provided, the `TLoaderDeps` object.

docs/router/api/router/RouterOptionsType.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ const router = createRouter({
219219
- Type: `LocationRewrite`
220220
- Optional
221221
- Configures bidirectional URL transformation between the browser URL and the router's internal URL.
222-
- See the [URL Rewrites guide](../../framework/react/guide/url-rewrites.md) for detailed usage and patterns.
222+
- See the [URL Rewrites guide](../../guide/url-rewrites.md) for detailed usage and patterns.
223223

224224
The `LocationRewrite` type has the following shape:
225225

@@ -341,7 +341,7 @@ const router = createRouter({
341341
- Type: `'root' | 'fuzzy'`
342342
- Optional
343343
- Defaults to `'fuzzy'`
344-
- This property controls how TanStack Router will handle scenarios where it cannot find a route to match the current location. See the [Not Found Errors guide](../../framework/react/guide/not-found-errors.md) for more information.
344+
- This property controls how TanStack Router will handle scenarios where it cannot find a route to match the current location. See the [Not Found Errors guide](../../guide/not-found-errors.md) for more information.
345345

346346
### `notFoundRoute` property
347347

@@ -369,7 +369,7 @@ const router = createRouter({
369369
- Optional
370370
- Defaults to `false`
371371
- Configures whether structural sharing is enabled by default for fine-grained selectors.
372-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
372+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
373373

374374
### `defaultRemountDeps` property
375375

docs/router/api/router/createLazyFileRouteFunction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: createLazyFileRouteFunction
33
title: createLazyFileRoute function
44
---
55

6-
The `createLazyFileRoute` function is used for creating a partial file-based route route instance that is lazily loaded when matched. This route instance can only be used to configure the [non-critical properties](../../framework/react/guide/code-splitting.md#how-does-tanstack-router-split-code) of the route, such as `component`, `pendingComponent`, `errorComponent`, and the `notFoundComponent`.
6+
The `createLazyFileRoute` function is used for creating a partial file-based route route instance that is lazily loaded when matched. This route instance can only be used to configure the [non-critical properties](../../guide/code-splitting.md#how-does-tanstack-router-split-code) of the route, such as `component`, `pendingComponent`, `errorComponent`, and the `notFoundComponent`.
77

88
## createLazyFileRoute options
99

docs/router/api/router/createLazyRouteFunction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: createLazyRouteFunction
33
title: createLazyRoute function
44
---
55

6-
The `createLazyRoute` function is used for creating a partial code-based route route instance that is lazily loaded when matched. This route instance can only be used to configure the [non-critical properties](../../framework/react/guide/code-splitting.md#how-does-tanstack-router-split-code) of the route, such as `component`, `pendingComponent`, `errorComponent`, and the `notFoundComponent`.
6+
The `createLazyRoute` function is used for creating a partial code-based route route instance that is lazily loaded when matched. This route instance can only be used to configure the [non-critical properties](../../guide/code-splitting.md#how-does-tanstack-router-split-code) of the route, such as `component`, `pendingComponent`, `errorComponent`, and the `notFoundComponent`.
77

88
## createLazyRoute options
99

docs/router/api/router/useBlockerHook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: useBlockerHook
33
title: useBlocker hook
44
---
55

6-
The `useBlocker` method is a hook that [blocks navigation](../../framework/react/guide/navigation-blocking.md) when a condition is met.
6+
The `useBlocker` method is a hook that [blocks navigation](../../guide/navigation-blocking.md) when a condition is met.
77

88
> ⚠️ The following new `useBlocker` API is currently _experimental_.
99

docs/router/api/router/useChildMatchesHook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `useChildMatches` hook accepts a single _optional_ argument, an `options` ob
2323
- Type: `boolean`
2424
- Optional
2525
- Configures whether structural sharing is enabled for the value returned by `select`.
26-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
26+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
2727

2828
## useChildMatches returns
2929

docs/router/api/router/useLoaderDataHook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The `useLoaderData` hook accepts an `options` object.
3434
- Type: `boolean`
3535
- Optional
3636
- Configures whether structural sharing is enabled for the value returned by `select`.
37-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
37+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
3838

3939
## useLoaderData returns
4040

docs/router/api/router/useLoaderDepsHook.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The `useLoaderDepsHook` hook accepts an `options` object.
2626
- Type: `boolean`
2727
- Optional
2828
- Configures whether structural sharing is enabled for the value returned by `select`.
29-
- See the [Render Optimizations guide](../../framework/react/guide/render-optimizations.md) for more information.
29+
- See the [Render Optimizations guide](../../guide/render-optimizations.md) for more information.
3030

3131
## useLoaderDeps returns
3232

0 commit comments

Comments
 (0)