Skip to content

docs: add How To section to navigation sidebar#7058

Closed
cyphercodes wants to merge 1 commit intoTanStack:mainfrom
cyphercodes:fix/how-to-docs-navigation
Closed

docs: add How To section to navigation sidebar#7058
cyphercodes wants to merge 1 commit intoTanStack:mainfrom
cyphercodes:fix/how-to-docs-navigation

Conversation

@cyphercodes
Copy link
Copy Markdown

@cyphercodes cyphercodes commented Mar 27, 2026

The how-to guides in docs/router/how-to/ were not accessible from the navigation sidebar, as reported in #6801.

This PR adds a new 'How To' section after ESLint and before Router Examples, making all 20+ guides discoverable.

Fixes #6801

Summary by CodeRabbit

  • Documentation
    • Added a new "How To" section with guides for installation, setup, authentication, testing, debugging, deployment, environment variables, and UI integrations with support for React and Solid frameworks.

The how-to guides in docs/router/how-to/ were not accessible from the
navigation sidebar. This adds a new 'How To' section after ESLint and
before Router Examples, making all 20+ guides discoverable.

Fixes TanStack#6801
@github-actions github-actions bot added the documentation Everything documentation related label Mar 27, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 45752e9c-fd1f-4b67-9074-9944745c531f

📥 Commits

Reviewing files that changed from the base of the PR and between 21bd992 and 52102fa.

📒 Files selected for processing (1)
  • docs/router/config.json

📝 Walkthrough

Walkthrough

A new "How To" section was added to the TanStack Router documentation navigation configuration with structured child items covering various guides including setup, testing, deployment, and framework integration.

Changes

Cohort / File(s) Summary
Documentation Navigation
docs/router/config.json
Added "How To" top-level section to navigation with 17+ child items (Overview, Install, authentication/RBAC/SSR/testing setup, Search Params, file-based routing tests, Debugging, Deployment, Environment Variables, UI integrations, React Router migration) and framework entries for React and Solid, all mapping to corresponding documentation paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The docs were hiding, lost from sight,
A "How To" path, now shining bright!
From auth to tests, deployment's way,
Our hopping friends can learn and play! ✨

🚥 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 summarizes the main change: adding a 'How To' section to the navigation sidebar in the documentation.
Linked Issues check ✅ Passed The PR successfully addresses all coding requirements from issue #6801: adds a 'How To' section to the sidebar navigation after ESLint and before Router Examples, making the 20+ how-to guides discoverable.
Out of Scope Changes check ✅ Passed All changes in the PR are scoped to the objective: only the docs/router/config.json file was modified to add the 'How To' navigation section with no unrelated alterations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@schiller-manuel
Copy link
Copy Markdown
Contributor

schiller-manuel commented Mar 27, 2026

those howtos are not ready for consumption

@cyphercodes
Copy link
Copy Markdown
Author

@schiller-manuel Thanks for the feedback! Could you clarify what needs to be done to make the How To section ready? I'm happy to make any necessary changes.

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

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

"How To" section is missing from the navigation sidebar of the TanStack Router documentation page

2 participants