Skip to content

docs(start): explain parent route outlets#7831

Draft
coyaSONG wants to merge 1 commit into
TanStack:mainfrom
coyaSONG:agent/docs-parent-route-outlet
Draft

docs(start): explain parent route outlets#7831
coyaSONG wants to merge 1 commit into
TanStack:mainfrom
coyaSONG:agent/docs-parent-route-outlet

Conversation

@coyaSONG

Copy link
Copy Markdown

Summary

  • explain that generated parent route components must render an Outlet
  • add matching parent-route examples for React and Solid Start
  • document the automatic-outlet alternative when no shared layout is needed

Why

The route generator creates new files with a starter component. When a file such
as posts.tsx becomes the parent of posts/index.tsx and
posts/$postId.tsx, that component replaces the router's automatic outlet. The
child route still matches, but its content cannot appear unless the parent
component renders <Outlet />.

This puts the fix next to the route-file table where users first create that
hierarchy, and also explains that removing the generated component option
restores the automatic outlet.

Closes #5351

Validation

  • pnpm exec prettier --experimental-cli --check docs/start/framework/react/guide/routing.md docs/start/framework/solid/guide/routing.md
  • pnpm test:docs (244 Markdown files, no broken links)
  • CI=1 NX_DAEMON=false pnpm nx affected --target=test:eslint --exclude='examples/**,e2e/**' --outputStyle=stream --skipRemoteCache (no affected package tasks for the docs-only diff)
  • CI=1 NX_DAEMON=false pnpm nx affected --target=test:types --exclude='examples/**' --outputStyle=stream --skipRemoteCache (no affected package tasks for the docs-only diff)
  • CI=1 NX_DAEMON=false pnpm nx affected --target=test:unit --exclude='examples/**,e2e/**' --outputStyle=stream --skipRemoteCache (no affected package tasks for the docs-only diff)

Disclosure

This contribution was prepared with OpenAI Codex assistance and manually
verified against the route-generator implementation and the repository's
documentation guidance.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 45ca159d-962b-4c7d-929a-be5e30bc5940

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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