Update framework comparison documentations for TanStack Router and TanStack Start #6170

femincan · 2025-12-21T10:30:25Z

I updated the router/comparison.md and start/comparison.md.

Here is the changes:

From the page title the "Start" part removed in TanStack Router comparison
From the table header of TanStack Router the "Start" part is removed and for React Router the "DOM" part is removed because the documentation uses "React Router" as the framework name.
The badges updated with appropriate colors for each framework with an appropriate badge style which complements with the bundle size badges.
The unused link references removed, the link references reordered according to usage order and website link for React Router updated. Now it points to the website instead of the GitHub repository.
The link reference name is updated for React Router for consistency with the Start comparison page.

Summary by CodeRabbit

Documentation
- Updated comparison pages with standardized framework naming across TanStack Router and React Router references.
- Refreshed badge identifiers and external resource links throughout framework comparison documentation.
- Enhanced link anchors and table formatting definitions for consistent documentation structure and reference accuracy.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-21T10:30:37Z

Walkthrough

This PR updates documentation comparison pages for React Router, replacing "TanStack Router / Start" references with "TanStack Router" and standardizing badge names and links from old React Router naming conventions to new ones. Changes are documentation-only.

Changes

Cohort / File(s)	Summary
React Router comparison documentation `docs/router/framework/react/comparison.md`, `docs/start/framework/react/comparison.md`	Updates comparison table headers and content to replace "TanStack Router / Start" with "TanStack Router"; replaces badge references (e.g., gh-router, stars-router to gh-react-router, stars-react-router); reorders comparison table columns; updates bundle size badge definitions and link anchors for consistency

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Changes are purely documentation updates with no functional code modifications
Primarily cosmetic badge/link renamings applied consistently across two comparison tables
Straightforward table reordering and content replacement

Possibly related PRs

docs: Add comparison page back #5503: Modifies the same comparison.md files and badge/link definitions; appears to be related configuration updates
docs: fix router commands in quick-start #5499: Standardizes documentation renaming from TanStack Router to React Router across docs-only changes
docs: Update Some Router Docs #5443: Prior modification to the same docs/router/framework/react/comparison.md file

Suggested labels

documentation

Suggested reviewers

brenelz
birkskyum

Poem

🐰 A Rabbit's Tale of Badges and Links

Badges renamed with care and delight,
TanStack Router shines ever bright,
Links now flow in their proper place,
Comparison tables with elegant grace! 🌟

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly summarizes the main changes: updating framework comparison documentation for TanStack Router and TanStack Start by removing 'Start' references and updating badge/link references.
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
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6839bfb and 1d1848f.

📒 Files selected for processing (2)

docs/router/framework/react/comparison.md (3 hunks)
docs/start/framework/react/comparison.md (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use relative links to docs/ folder format (e.g., ./guide/data-loading) for internal documentation references

Files:

docs/router/framework/react/comparison.md
docs/start/framework/react/comparison.md

🧠 Learnings (3)

📓 Common learnings

Learnt from: nlynzaad
Repo: TanStack/router PR: 5182
File: e2e/react-router/basic-file-based/src/routes/non-nested/named/$baz_.bar.tsx:3-5
Timestamp: 2025-09-22T00:56:49.237Z
Learning: In TanStack Router, underscores are intentionally stripped from route segments (e.g., `$baz_` becomes `baz` in generated types) but should be preserved in base path segments. This is the correct behavior as of the fix in PR #5182.

Learnt from: nlynzaad
Repo: TanStack/router PR: 5182
File: e2e/react-router/basic-file-based/tests/non-nested-paths.spec.ts:167-172
Timestamp: 2025-09-22T00:56:53.426Z
Learning: In TanStack Router, underscores are intentionally stripped from route segments during path parsing, but preserved in base path segments. This is the expected behavior implemented in PR #5182.

📚 Learning: 2025-10-14T18:59:33.990Z

Learnt from: FatahChan
Repo: TanStack/router PR: 5475
File: e2e/react-start/basic-prerendering/src/routes/redirect/$target/via-beforeLoad.tsx:8-0
Timestamp: 2025-10-14T18:59:33.990Z
Learning: In TanStack Router e2e test files, when a route parameter is validated at the route level (e.g., using zod in validateSearch or param validation), switch statements on that parameter do not require a default case, as the validation ensures only expected values will reach the switch.

Applied to files:

docs/router/framework/react/comparison.md
docs/start/framework/react/comparison.md

📚 Learning: 2025-12-06T15:03:07.223Z

Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-06T15:03:07.223Z
Learning: Applies to **/*.{js,ts,tsx} : Implement ESLint rules for router best practices using the ESLint plugin router

Applied to files:

docs/router/framework/react/comparison.md

🪛 LanguageTool

docs/router/framework/react/comparison.md

[uncategorized] ~22-~22: The official name of this software platform is spelled with a capital “H”.
Context: ...----------------------------------- | | Github Repo / Stars ...

(GITHUB)

🪛 markdownlint-cli2 (0.18.1)

docs/router/framework/react/comparison.md

22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)

22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)

22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)

23-23: Images should have alternate text (alt text)

(MD045, no-alt-text)

23-23: Images should have alternate text (alt text)

(MD045, no-alt-text)

84-84: Link and image reference definitions should be needed
Unused link or image reference definition: "_"

(MD053, link-image-reference-definitions)

90-90: Link and image reference definitions should be needed
Duplicate link or image reference definition: "_"

(MD053, link-image-reference-definitions)

docs/start/framework/react/comparison.md

31-31: Images should have alternate text (alt text)

(MD045, no-alt-text)

31-31: Images should have alternate text (alt text)

(MD045, no-alt-text)

329-329: Link and image reference definitions should be needed
Unused link or image reference definition: "_"

(MD053, link-image-reference-definitions)

333-333: Link and image reference definitions should be needed
Duplicate link or image reference definition: "_"

(MD053, link-image-reference-definitions)

339-339: Link and image reference definitions should be needed
Duplicate link or image reference definition: "_"

(MD053, link-image-reference-definitions)

🔇 Additional comments (4)

docs/start/framework/react/comparison.md (2)
31-31: Badge updates look good.

The bundle size badges for React Router have been properly added with consistent badgen.net and bundlephobia URLs, aligning with the TanStack Router badge pattern. The updates correctly accomplish the PR objective of standardizing badge styling.

Also applies to: 337-338

325-339: Convert internal link to relative format and remove unused placeholder definitions.

Line 340 uses an absolute site-root path [router-comparison]: /router/latest/docs/framework/react/comparison for an internal documentation reference. Per coding guidelines, this should use relative path format (e.g., ../../framework/react/comparison).

Additionally, remove the unused markdown reference placeholders [_]: _ at lines 329, 333, and 339 to maintain cleaner reference definitions.

Note: The external badge and framework links at lines 325-328, 330-332, and 334-338 are correctly formatted as absolute URLs and require no changes.
⛔ Skipped due to learnings
Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-06T15:03:07.223Z
Learning: Applies to docs/**/*.{md,mdx} : Use relative links to `docs/` folder format (e.g., `./guide/data-loading`) for internal documentation references
Learnt from: schiller-manuel
Repo: TanStack/router PR: 5330
File: packages/router-core/src/router.ts:2231-2245
Timestamp: 2025-10-01T18:30:26.591Z
Learning: In `packages/router-core/src/router.ts`, the `resolveRedirect` method intentionally strips the router's origin from redirect URLs when they match (e.g., `https://foo.com/bar` → `/bar` for same-origin redirects) while preserving the full URL for cross-origin redirects. This logic should not be removed or simplified to use `location.publicHref` directly.
Learnt from: CR
Repo: TanStack/router PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-06T15:03:07.223Z
Learning: Applies to **/*.{js,ts,tsx} : Implement ESLint rules for router best practices using the ESLint plugin router
docs/router/framework/react/comparison.md (2)

2-2: Title and table headers updated correctly.

The title now shows "TanStack Router vs Next.js vs React Router" (removing "Start"), and table headers have been cleaned up to remove "DOM" from React Router and reordered for better clarity. These changes align perfectly with the PR objectives and improve the accuracy of the framework comparison.

Also applies to: 20-20

85-89: React Router badge references properly configured.

The new React Router badge definitions include updated website link (https://reactrouter.com), correct GitHub repository reference, and consistent bundlephobia URLs. The badge color (#F44250) is appropriately distinct from other frameworks. These updates align with the PR objective to standardize badge styling and update the website reference.

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.}

femincan added 7 commits December 21, 2025 07:39

docs: remove unused link reference

6473c33

docs: update link references

f9c4c8d

docs: update compared framework names

0ea47f5

docs: reorder link references

223112f

docs: remove unused link references

f8a78e6

docs: update link reference names of react-router

3834c01

docs: update link references

1d1848f

github-actions bot added the documentation Everything documentation related label Dec 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Update framework comparison documentations for TanStack Router and TanStack Start #6170

Update framework comparison documentations for TanStack Router and TanStack Start #6170

femincan commented Dec 21, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 21, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Update framework comparison documentations for TanStack Router and TanStack Start #6170

Are you sure you want to change the base?

Update framework comparison documentations for TanStack Router and TanStack Start #6170

Conversation

femincan commented Dec 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Dec 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

femincan commented Dec 21, 2025 •

edited

Loading

coderabbitai bot commented Dec 21, 2025 •

edited

Loading