Skip to content

Commit 12a30c5

Browse files
tannerlinsleycursoragentautofix-ci[bot]
authored
docs: Identify top 10 how-to docs, add deployment guide (#4701)
<!-- One very short sentence on the WHAT and WHY of the PR. E.g. "Remove pathHash attribute because it is confirmed unused." or "Add DNS round robin to improve load distribution." --> Add a comprehensive how-to guide for deploying TanStack Router to production and establish a multi-PR process for future documentation. --------- Co-authored-by: Cursor Agent <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent fcba134 commit 12a30c5

File tree

4 files changed

+917
-10
lines changed

4 files changed

+917
-10
lines changed
Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,34 @@
11
# How-To Guides
22

3-
This directory contains terse, step-by-step instructions for common TanStack Router tasks. Each guide is designed to be:
3+
This directory contains focused, step-by-step instructions for common TanStack Router tasks. Each guide is designed to be:
44

5-
- **Bite-sized**: Focused on a single, specific task
6-
- **Actionable**: Step-by-step instructions you can follow immediately
7-
- **Concise**: No extra explanation, just the essential steps
8-
- **Targeted**: Easy for both users and AI to find exactly what they need
5+
- **Task-focused**: Covers one specific goal from start to finish
6+
- **Self-contained**: All necessary steps included, no prerequisites assumed
7+
- **Copy-paste ready**: Working code examples you can use immediately
8+
- **Problem-solving oriented**: Addresses real-world scenarios and common issues
99

1010
## Available Guides
1111

1212
- [Install TanStack Router](./install.md) - Basic installation steps
13+
- [Deploy to Production](./deploy-to-production.md) - Deploy your app to hosting platforms
14+
15+
## Using These Guides
16+
17+
Each guide follows a consistent structure:
18+
19+
1. **Quick Start** - Brief overview of what you'll accomplish
20+
2. **Step-by-step instructions** - Platform-specific or scenario-specific guidance
21+
3. **Production checklist** - Verification steps (where applicable)
22+
4. **Common problems** - Troubleshooting for typical issues
23+
5. **Common next steps** - Optional related tasks you might want to tackle
1324

1425
## Contributing
1526

1627
When adding new how-to guides:
1728

18-
1. Keep each guide focused on one specific task
19-
2. Use numbered steps for clarity
20-
3. Include prerequisites if needed
21-
4. Provide next steps or related guides
22-
5. Check existing documentation for duplicate content and update references accordingly
29+
1. Focus on a single, well-defined task
30+
2. Use clear headings and numbered steps
31+
3. Include complete, working code examples
32+
4. Address the most frequent problems at the end
33+
5. Comment out "Common next steps" links until those guides are created
34+
6. In "Related Resources", link to specific relevant resources, not generic documentation

0 commit comments

Comments
 (0)