Skip to content

docs: note layout routes require an Outlet element - #7899

Open
wasim-builds wants to merge 1 commit into
TanStack:mainfrom
wasim-builds:docs/add-outlet-layout-routes
Open

docs: note layout routes require an Outlet element#7899
wasim-builds wants to merge 1 commit into
TanStack:mainfrom
wasim-builds:docs/add-outlet-layout-routes

Conversation

@wasim-builds

@wasim-builds wasim-builds commented Jul 25, 2026

Copy link
Copy Markdown

Fixes a documentation issue where layout routes did not explicitly mention the requirement of an <Outlet /> component to render child routes.

Summary by CodeRabbit

  • Documentation
    • Added routing guidance for React and Solid explaining that layout routes require an <Outlet /> to render nested child routes.
    • Included examples of nested routes that depend on the outlet.

@coderabbitai

coderabbitai Bot commented Jul 25, 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: 55985309-87ef-4cf3-b403-8bb6c542a6fe

📥 Commits

Reviewing files that changed from the base of the PR and between 88f366a and 4657c03.

📒 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 note that generated layout route components do not include <Outlet /> automatically. Developers must add it to layout routes such as posts.tsx to render index and parameterized child routes.

Changes

Layout route documentation

Layer / File(s) Summary
Document explicit Outlet requirement
docs/start/framework/{react,solid}/guide/routing.md
Adds notes explaining that layout routes require an explicit <Outlet /> to render child routes.

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

Possibly related PRs

Suggested labels: package: router-generator

🚥 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 and concisely describes the main documentation change about layout routes needing an Outlet.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@wasim-builds

Copy link
Copy Markdown
Author

By the way, I've really been enjoying exploring the TanStack router codebase! My goal is to get more involved in open source to help maintain projects and learn from great engineering teams. Is there a process or pathway for becoming a member of the TanStack GitHub organization? I'd love to continue helping out where I can!

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.

1 participant