Skip to content

docs(start): explain generated layout routes - #7935

Open
ThomasConway01 wants to merge 1 commit into
TanStack:mainfrom
ThomasConway01:codex/docs-5351-layout-route-outlet
Open

docs(start): explain generated layout routes#7935
ThomasConway01 wants to merge 1 commit into
TanStack:mainfrom
ThomasConway01:codex/docs-5351-layout-route-outlet

Conversation

@ThomasConway01

@ThomasConway01 ThomasConway01 commented Aug 2, 2026

Copy link
Copy Markdown

Closes #5351.

This adds matching React and Solid examples for posts.tsx layout routes. The guides now explain why a generated standalone page component needs to be replaced with a component that renders <Outlet /> before adding nested index or dynamic routes.

I used OpenAI Codex (GPT-5.6) with substantive assistance for the documentation change and review.

I verified the diff with git diff --check and cross-checked the examples against the existing Router layout-route documentation. I also attempted the documented workspace install and link checker, but dependency linking exceeded the local command time limit before those checks could start.

Summary by CodeRabbit

  • Documentation
    • Added routing guidance for React and Solid applications.
    • Explained how to configure posts.tsx as a layout route using an outlet so nested routes display correctly.
    • Included complete layout examples and instructions for replacing generated standalone pages before adding child routes.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8bc78046-fe74-4c18-86c6-537dddea63ef

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb221c and 0e159fe.

📒 Files selected for processing (2)
  • docs/start/framework/react/guide/routing.md
  • docs/start/framework/solid/guide/routing.md

📝 Walkthrough

Walkthrough

The React and Solid routing guides now explain that posts.tsx must become a layout route. Each guide includes a createFileRoute('/posts') example that renders <Outlet /> before users add child routes.

Changes

Posts layout route guidance

Layer / File(s) Summary
Document posts layout routes
docs/start/framework/react/guide/routing.md, docs/start/framework/solid/guide/routing.md
The guides explain how to replace the generated standalone posts.tsx page with a layout route. The examples render <Outlet /> so nested routes appear.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the documentation change for generated layout routes.
Linked Issues check ✅ Passed The React and Solid documentation explains how to convert generated posts.tsx files into layout routes with for nested routes, satisfying issue #5351.
Out of Scope Changes check ✅ Passed All changes support the linked documentation objective and remain limited to React and Solid routing guides.
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

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

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation Getting Started Flow - auto file gen can get users stuck

1 participant