docs: remove gitignore suggestion for generated route tree file

[Yavnik]

As per issue #5354

This PR resolves an inconsistency between Router and Start documentation about whether to commit the generated route tree file routeTree.gen.ts and if it is a build artifact.

Router docs says:

You should commit this file into git ... it is essentially part of your application’s runtime, not a build artifact.

Start docs says

You may gitignore this file, since it is a build artifact

Changes:

• Removed the recommendation to .gitignore the routeTree.gen.ts file from the Start documentation.

• Establishes the Router documentation as the single source of truth for handling generated route files.

Summary by CodeRabbit

• Documentation
  • Updated React and Solid routing guides.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Removed a note from the React and Solid framework routing documentation stating that the routeTree.gen.ts file may be gitignored as a build artifact. These are documentation-only edits with no functional changes.

Changes

Cohort / File(s)	Change Summary
Documentation updates docs/start/framework/react/guide/routing.md, docs/start/framework/solid/guide/routing.md	Removed note about routeTree.gen.ts potentially being gitignored as a build artifact

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• update solid start docs #5347: Modifies the same routing documentation note about routeTree.gen.ts being treated as a build artifact
• docs(solid-router): large-file-based #5842: Adds .gitignore and .vscode rules for the generated routeTree.gen.ts file, providing explicit ignore instructions
• docs(solid-router): webpack example and installation guide #5833: Adds examples and explicit guidance around ignoring routeTree.gen.ts in editor and version control settings

Suggested labels

documentation

Suggested reviewers

• schiller-manuel
• birkskyum

Poem

🐰 A note removed from pages fair,
The gitignore gossip floats away,
Less clutter in the routing guide—
Clean prose is what we write today! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately summarizes the main change: removing a gitignore suggestion for the generated route tree file from documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34d13e5 and 7cf2089.

📒 Files selected for processing (2)

• docs/start/framework/react/guide/routing.md (0 hunks)
• docs/start/framework/solid/guide/routing.md (0 hunks)

💤 Files with no reviewable changes (2)

• docs/start/framework/react/guide/routing.md
• docs/start/framework/solid/guide/routing.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Cleanup artifacts

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR resolves a documentation inconsistency between TanStack Router and TanStack Start regarding the routeTree.gen.ts file. The Router documentation explicitly states this file should be committed to git as it's part of the application's runtime, not a build artifact, while the Start documentation incorrectly suggested gitignoring it as a build artifact.

• Removed the conflicting gitignore recommendation from Start documentation
• Established Router FAQ as the single source of truth for handling the generated route tree file

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
docs/start/framework/react/guide/routing.md	Removed the statement suggesting to gitignore routeTree.gen.ts as a build artifact
docs/start/framework/solid/guide/routing.md	Removed the statement suggesting to gitignore routeTree.gen.ts as a build artifact

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.