Skip to content

Commit 238c63f

Browse files
authored
docs(router): update links in how-to guides (#4878)
1 parent c94fa35 commit 238c63f

15 files changed

+55
-55
lines changed

docs/router/framework/react/how-to/arrays-objects-dates-search-params.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,7 @@ const onlyNeededData = Route.useSearch({
756756

757757
## Related Resources
758758

759-
- [Search Params Guide](../guide/search-params.md) - Core concepts and JSON-first approach
759+
- [Search Params Guide](../../guide/search-params.md) - Core concepts and JSON-first approach
760760
- [Zod Documentation](https://zod.dev/) - Schema validation library
761761
- [MDN Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - Date serialization reference
762762
- [URLSearchParams Limits](https://stackoverflow.com/questions/417142/what-is-the-maximum-length-of-a-url-in-different-browsers) - Browser URL length limits

docs/router/framework/react/how-to/debug-router-issues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -753,8 +753,8 @@ const route = createRoute({
753753

754754
After debugging router issues, you might want to:
755755

756-
- [How to Set Up Testing](./setup-testing.md) - Add tests to prevent regressions
757-
- [How to Deploy to Production](./deploy-to-production.md) - Ensure issues don't occur in production
756+
- [How to Set Up Testing](../setup-testing.md) - Add tests to prevent regressions
757+
- [How to Deploy to Production](../deploy-to-production.md) - Ensure issues don't occur in production
758758

759759
<!-- TODO: Uncomment as guides are created
760760
- [How to Optimize Performance](./optimize-performance.md)

docs/router/framework/react/how-to/deploy-to-production.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -434,9 +434,9 @@ Before deploying, ensure you have:
434434

435435
After deployment, you might want to:
436436

437-
- [How to Set Up Basic Authentication](./setup-authentication.md) - Secure your application with auth
438-
- [Migrate from React Router v7](./migrate-from-react-router.md) - Complete migration guide if you're coming from React Router
439-
- [How to Set Up Server-Side Rendering (SSR)](./setup-ssr.md)
437+
- [How to Set Up Basic Authentication](../setup-authentication.md) - Secure your application with auth
438+
- [Migrate from React Router v7](../migrate-from-react-router.md) - Complete migration guide if you're coming from React Router
439+
- [How to Set Up Server-Side Rendering (SSR)](../setup-ssr.md)
440440

441441
<!-- TODO: Uncomment as how-to guides are created
442442
- [How to Optimize Performance](./optimize-performance.md)

docs/router/framework/react/how-to/migrate-from-react-router.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ Before deploying your migrated application:
678678
1. TanStack Router has built-in SSR capabilities - use TanStack Start for full-stack applications
679679
2. Use TanStack Router's lazy routes for code splitting
680680
3. Configure SSR using TanStack Router's native APIs
681-
4. Follow the [SSR setup guide](./setup-ssr.md) for detailed instructions
681+
4. Follow the [SSR setup guide](../setup-ssr.md) for detailed instructions
682682

683683
### Routes Not Matching
684684

@@ -737,8 +737,8 @@ After successfully migrating to TanStack Router, consider these enhancements:
737737
## Related Resources
738738

739739
- [TanStack Router Documentation](https://tanstack.com/router) - Complete API reference
740-
- [File-Based Routing Guide](../routing/file-based-routing.md) - Detailed routing concepts
741-
- [Navigation Guide](../guide/navigation.md) - Complete navigation patterns
742-
- [Search Parameters Guide](../guide/search-params.md) - Advanced search param usage
743-
- [Type Safety Guide](../guide/type-safety.md) - TypeScript integration details
740+
- [File-Based Routing Guide](../../routing/file-based-routing.md) - Detailed routing concepts
741+
- [Navigation Guide](../../guide/navigation.md) - Complete navigation patterns
742+
- [Search Parameters Guide](../../guide/search-params.md) - Advanced search param usage
743+
- [Type Safety Guide](../../guide/type-safety.md) - TypeScript integration details
744744
- [React Router v7 Changelog](https://reactrouter.com/start/changelog) - What changed in v7

docs/router/framework/react/how-to/navigate-with-search-params.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: How to Navigate with Search Parameters
44

55
This guide covers updating and managing search parameters during navigation using TanStack Router's Link components and programmatic navigation methods.
66

7-
**Prerequisites:** [Set Up Basic Search Parameters](./setup-basic-search-params.md) - Foundation concepts for reading and validating search params.
7+
**Prerequisites:** [Set Up Basic Search Parameters](../setup-basic-search-params.md) - Foundation concepts for reading and validating search params.
88

99
## Quick Start
1010

@@ -333,8 +333,8 @@ function ConditionalNavigation() {
333333

334334
After mastering navigation with search parameters, you might want to:
335335

336-
- [Validate Search Parameters with Schemas](./validate-search-params.md) - Add robust validation with Zod, Valibot, or ArkType
337-
- [Work with Arrays, Objects, and Dates](./arrays-objects-dates-search-params.md) - Handle arrays, objects, dates, and nested data structures
336+
- [Validate Search Parameters with Schemas](../validate-search-params.md) - Add robust validation with Zod, Valibot, or ArkType
337+
- [Work with Arrays, Objects, and Dates](../arrays-objects-dates-search-params.md) - Handle arrays, objects, dates, and nested data structures
338338

339339
<!-- Uncomment when guides are available
340340
- [Share Search Parameters Across Routes](./share-search-params-across-routes.md) - Inherit and manage search params across route hierarchies

docs/router/framework/react/how-to/setup-auth-providers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,8 @@ export const Route = createFileRoute('/_authenticated')({
619619

620620
After integrating authentication providers, you might want to:
621621

622-
- [How to Set Up Role-Based Access Control](./setup-rbac.md) - Add permission-based routing
623-
- [How to Set Up Basic Authentication](./setup-authentication.md) - Custom auth implementation
622+
- [How to Set Up Role-Based Access Control](../setup-rbac.md) - Add permission-based routing
623+
- [How to Set Up Basic Authentication](../setup-authentication.md) - Custom auth implementation
624624

625625
<!-- TODO: Uncomment as how-to guides are created
626626
- [How to Handle User Sessions](./handle-user-sessions.md)

docs/router/framework/react/how-to/setup-authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -470,8 +470,8 @@ export const Route = createFileRoute('/_authenticated/dashboard')({
470470

471471
After setting up basic authentication, you might want to:
472472

473-
- [How to Integrate Authentication Providers](./setup-auth-providers.md) - Use Auth0, Clerk, or Supabase
474-
- [How to Set Up Role-Based Access Control](./setup-rbac.md) - Add permission-based routing
473+
- [How to Integrate Authentication Providers](../setup-auth-providers.md) - Use Auth0, Clerk, or Supabase
474+
- [How to Set Up Role-Based Access Control](../setup-rbac.md) - Add permission-based routing
475475

476476
<!-- TODO: Uncomment as how-to guides are created
477477
- [How to Handle User Sessions](./handle-user-sessions.md)
@@ -480,6 +480,6 @@ After setting up basic authentication, you might want to:
480480

481481
## Related Resources
482482

483-
- [Authenticated Routes Guide](../guide/authenticated-routes.md) - Detailed conceptual guide
484-
- [Router Context Guide](../guide/router-context.md) - Understanding context in TanStack Router
483+
- [Authenticated Routes Guide](../../guide/authenticated-routes.md) - Detailed conceptual guide
484+
- [Router Context Guide](../../guide/router-context.md) - Understanding context in TanStack Router
485485
- [Authentication Examples](https://github.com/TanStack/router/tree/main/examples/react/authenticated-routes) - Complete working examples

docs/router/framework/react/how-to/setup-basic-search-params.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export const Route = createFileRoute('/products')({
7171
})
7272
```
7373

74-
**For detailed validation library comparisons and advanced validation patterns, see:** [Validate Search Parameters with Schemas](./validate-search-params.md)
74+
**For detailed validation library comparisons and advanced validation patterns, see:** [Validate Search Parameters with Schemas](../validate-search-params.md)
7575

7676
## Step-by-Step Setup with Zod
7777

@@ -414,9 +414,9 @@ const schema = z.object({
414414

415415
After setting up basic search parameters, you might want to:
416416

417-
- [Validate Search Parameters with Schemas](./validate-search-params.md) - Add robust validation with Zod, Valibot, or ArkType
418-
- [Navigate with Search Parameters](./navigate-with-search-params.md) - Learn to update search params with Links and navigation
419-
- [Work with Arrays, Objects, and Dates](./arrays-objects-dates-search-params.md) - Handle arrays, objects, dates, and nested data structures
417+
- [Validate Search Parameters with Schemas](../validate-search-params.md) - Add robust validation with Zod, Valibot, or ArkType
418+
- [Navigate with Search Parameters](../navigate-with-search-params.md) - Learn to update search params with Links and navigation
419+
- [Work with Arrays, Objects, and Dates](../arrays-objects-dates-search-params.md) - Handle arrays, objects, dates, and nested data structures
420420

421421
## Related Resources
422422

@@ -427,5 +427,5 @@ After setting up basic search parameters, you might want to:
427427
- **TanStack Router:**
428428
- [TanStack Zod Adapter](https://tanstack.com/router/latest/docs/framework/react/api/router/zodValidator) - Official Zod adapter
429429
- [TanStack Valibot Adapter](https://tanstack.com/router/latest/docs/framework/react/api/router/valibotValidator) - Official Valibot adapter
430-
- [Search Parameters Guide](../guide/search-params.md) - Comprehensive search parameters documentation
431-
- [Type Safety Guide](../guide/type-safety.md) - Understanding TanStack Router's type safety
430+
- [Search Parameters Guide](../../guide/search-params.md) - Comprehensive search parameters documentation
431+
- [Type Safety Guide](../../guide/type-safety.md) - Understanding TanStack Router's type safety

docs/router/framework/react/how-to/setup-rbac.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,8 @@ function usePermissions() {
723723

724724
After setting up RBAC, you might want to:
725725

726-
- [How to Set Up Basic Authentication](./setup-authentication.md) - Core auth implementation
727-
- [How to Integrate Authentication Providers](./setup-auth-providers.md) - Use external auth services
726+
- [How to Set Up Basic Authentication](../setup-authentication.md) - Core auth implementation
727+
- [How to Integrate Authentication Providers](../setup-auth-providers.md) - Use external auth services
728728

729729
<!-- TODO: Uncomment as how-to guides are created
730730
- [How to Implement Dynamic Permissions](./setup-dynamic-permissions.md)
@@ -733,6 +733,6 @@ After setting up RBAC, you might want to:
733733

734734
## Related Resources
735735

736-
- [Authenticated Routes Guide](../guide/authenticated-routes.md) - Core authentication concepts
737-
- [Router Context Guide](../guide/router-context.md) - Understanding router context
736+
- [Authenticated Routes Guide](../../guide/authenticated-routes.md) - Core authentication concepts
737+
- [Router Context Guide](../../guide/router-context.md) - Understanding router context
738738
- [RBAC Best Practices](https://auth0.com/docs/manage-users/access-control/rbac) - General RBAC principles

docs/router/framework/react/how-to/setup-ssr.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: How to Set Up Server-Side Rendering (SSR)
33
---
44

5-
> [!IMPORTANT] > **[TanStack Start](../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.
5+
> [!IMPORTANT] > **[TanStack Start](../../guide/tanstack-start.md) is the recommended way to set up SSR** - it provides SSR, streaming, and deployment with zero configuration.
66
>
77
> Use the manual setup below only if you need to integrate with an existing server.
88
@@ -423,7 +423,7 @@ export default defineConfig(({ isSsrBuild }) => ({
423423

424424
## Common Problems
425425

426-
> [!TIP] > **Most of these problems are automatically solved by [TanStack Start](../guide/tanstack-start.md).** The issues below are primarily relevant for manual SSR setups.
426+
> [!TIP] > **Most of these problems are automatically solved by [TanStack Start](../../guide/tanstack-start.md).** The issues below are primarily relevant for manual SSR setups.
427427
428428
### React Import Errors
429429

@@ -537,15 +537,15 @@ const ssrConfig = {
537537

538538
## Related Resources
539539

540-
- [TanStack Start](../guide/tanstack-start.md) - **Recommended full-stack React framework with SSR**
541-
- [SSR Guide (Detailed)](../guide/ssr.md) - Comprehensive SSR concepts, utilities, and theory
542-
- [Data Loading](../guide/data-loading.md) - SSR-compatible data loading patterns
540+
- [TanStack Start](../../guide/tanstack-start.md) - **Recommended full-stack React framework with SSR**
541+
- [SSR Guide (Detailed)](../../guide/ssr.md) - Comprehensive SSR concepts, utilities, and theory
542+
- [Data Loading](../../guide/data-loading.md) - SSR-compatible data loading patterns
543543

544544
## Common Next Steps
545545

546-
- [Deploy to Production](./deploy-to-production.md) - Deploy your SSR app
547-
- [Setup Authentication](./setup-authentication.md) - Add auth to SSR routes
548-
- [Debug Router Issues](./debug-router-issues.md) - Troubleshoot SSR-specific routing problems
546+
- [Deploy to Production](../deploy-to-production.md) - Deploy your SSR app
547+
- [Setup Authentication](../setup-authentication.md) - Add auth to SSR routes
548+
- [Debug Router Issues](../debug-router-issues.md) - Troubleshoot SSR-specific routing problems
549549

550550
<!-- TODO: Uncomment as guides are created
551551
- [Fix Build Issues](./fix-build-issues.md) - Troubleshoot bundler problems

0 commit comments

Comments
 (0)