Skip to content

docs: add How To section to router documentation sidebar#6831

Open
isaackaara wants to merge 1 commit intoTanStack:mainfrom
isaackaara:docs/add-how-to-nav-section
Open

docs: add How To section to router documentation sidebar#6831
isaackaara wants to merge 1 commit intoTanStack:mainfrom
isaackaara:docs/add-how-to-nav-section

Conversation

@isaackaara
Copy link

@isaackaara isaackaara commented Mar 6, 2026

The docs/router/how-to/ directory contains 20 focused how-to guides covering installation, authentication, testing, UI library integration, and search parameter patterns, but they are not accessible from the documentation sidebar navigation.

This adds a "How To" section to config.json between the "ESLint" and "Router Examples" sections, listing all published guides. The guides were already live and individually accessible via direct URL (e.g. /router/latest/docs/how-to/test-file-based-routing), but users had no way to discover them through the sidebar.

Guides included:

  • Installation, environment variables, deployment, SSR
  • Authentication: basic setup, provider integration, RBAC
  • Testing: code-based routing, file-based routing, debugging
  • UI integration: Shadcn/ui, Material-UI, Framer Motion, Chakra UI
  • Search params: basics, navigation, validation, complex types, sharing across routes

Fixes #6801

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive "How To" section with guides covering installation, deployment, SSR setup, authentication, testing, debugging, UI framework integrations (Shadcn/ui, Material-UI, Framer Motion, Chakra UI), and search parameter management.

The docs/router/how-to/ directory contains 20 focused how-to guides
covering installation, authentication, testing, UI library integration,
and search parameters, but they were not accessible from the
documentation sidebar navigation.

This adds a 'How To' section to config.json between ESLint and Router
Examples, listing all published guides.

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

coderabbitai bot commented Mar 6, 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: e2f33672-64f3-4fca-8f44-45cec0620fd7

📥 Commits

Reviewing files that changed from the base of the PR and between cc12980 and c7482c7.

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

📝 Walkthrough

Walkthrough

Added a "How To" section to the documentation navigation configuration with twenty entries covering topics such as installation, environment variables, deployment, SSR, authentication, testing, UI framework integrations, and search parameters management.

Changes

Cohort / File(s) Summary
Navigation Configuration
docs/router/config.json
Added new "How To" section with 20 how-to guide entries, including installation, deployment, SSR setup, authentication, testing, framework integrations (Shadcn/ui, Material-UI, Framer Motion, Chakra UI), and search parameters guides.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 In the nav bar, a welcome sight,
How-to guides now shining bright,
From auth to test, SSR to frame,
The docs are whole—hooray!—at last the same!

🚥 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 accurately describes the main change: adding a 'How To' section to the router documentation sidebar config.
Linked Issues check ✅ Passed The PR successfully addresses issue #6801 by adding a 'How To' section to the sidebar configuration with 20 how-to guides positioned between 'ESLint' and 'Router Examples' sections.
Out of Scope Changes check ✅ Passed All changes are scoped to updating the docs/router/config.json file to add navigation entries for existing how-to guides, with no unrelated modifications.
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
  • Post copyable unit tests in a comment

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.

@github-actions
Copy link

github-actions bot commented Mar 6, 2026

Bundle Size Benchmarks

  • Commit: cc12980e1667
  • Measured at: 2026-03-06T04:56:47.902Z
  • Baseline source: history:cc12980e1667
  • Dashboard: bundle-size history
Scenario Current (gzip) Delta vs baseline Raw Brotli Trend
react-router.minimal 86.84 KiB 0 B (0.00%) 273.33 KiB 75.44 KiB ▁▁▁▁▁▁▁▁███
react-router.full 89.88 KiB 0 B (0.00%) 283.67 KiB 78.18 KiB ▁▁▁▁▁▁▁▁███
solid-router.minimal 36.17 KiB 0 B (0.00%) 108.44 KiB 32.49 KiB ▁▁▁▁▁▁▁▁███
solid-router.full 40.50 KiB 0 B (0.00%) 121.49 KiB 36.40 KiB ▁▁▁▁▁▁▁▁███
vue-router.minimal 52.03 KiB 0 B (0.00%) 148.42 KiB 46.71 KiB ▁▁▁▁▁▁▁▁███
vue-router.full 56.85 KiB 0 B (0.00%) 164.01 KiB 51.04 KiB ▁▁▁▁▁▁▁▁███
react-start.minimal 99.40 KiB 0 B (0.00%) 312.48 KiB 85.98 KiB ▁▁▁▁▁▁▁▁███
react-start.full 102.78 KiB 0 B (0.00%) 322.29 KiB 88.82 KiB ▁▁▁▁▁▁▁▁███
solid-start.minimal 48.49 KiB 0 B (0.00%) 146.03 KiB 42.85 KiB ▁▁▁▁▁▁▁▁███
solid-start.full 53.96 KiB 0 B (0.00%) 161.98 KiB 47.51 KiB ▁▁▁▁▁▁▁▁███

Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better.

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

1 participant