docs: Add comparison page back #5503

LadyBluenotes · 2025-10-17T04:01:47Z

Summary by CodeRabbit

Documentation
- Added a new side-by-side feature comparison page comparing TanStack Router & Start with Next.js, React Router and Remix, including capability matrices, status keys, and external resource links.
- Removed an older comparative discussion block and cleaned up minor comment artifacts from framework docs.
- Added a new "Comparison" entry to the React router documentation navigation.

coderabbitai · 2025-10-17T04:01:58Z

Walkthrough

Adds a new React framework comparison doc and updates site navigation; removes redundant comparison commentary from React and Solid overview pages. All changes are documentation-only.

Changes

Cohort / File(s)	Summary
New documentation page `docs/router/framework/react/comparison.md`	Adds a dedicated side-by-side comparison page (front matter, status key, capability matrix comparing TanStack Router/Start, React Router DOM, and Next.js, resource links, and badge/reference footers).
Overview cleanup `docs/router/framework/react/overview.md`, `docs/router/framework/solid/overview.md`	Removes the "WhyChooseTanStackRouter" markdown comment blocks and associated comparison text from both overview pages.
Navigation update `docs/router/config.json`	Inserts a new React nav entry: `{ "label": "Comparison", "to": "framework/react/comparison" }` under the React framework children array.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

docs: add in llm support page #5479 — modifies docs/router/config.json navigation entries; overlaps with nav additions here.
docs: Update Some Router Docs #5443 — touches the same comparison doc and config entries; may conflict with this PR's addition.

Suggested reviewers

schiller-manuel
birkskyum
brenelz

Poem

🐇 I found a new page beneath the log,

Tables aligned like rows of fog.
Old notes hopped away, content refound,
A tidy meadow where features abound.
🥕 Hooray for docs — neat, new, and sound!

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 pull request title "docs: Add comparison page back" directly corresponds to the primary change in the changeset—the addition of a new comparison documentation page at `docs/router/framework/react/comparison.md` that presents a feature comparison between TanStack Router & Start versus Next.js and React Router/Remix. The title is concise, specific, and uses the appropriate "docs:" prefix convention. While the changeset also includes supporting modifications (removal of WhyChooseTanStackRouter section, config updates, and comment removals), the title accurately identifies the main objective without unnecessary detail, which aligns with expected standards for PR titles.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9940112 and e405b14.

📒 Files selected for processing (1)

docs/router/config.json (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

docs/router/config.json

🔇 Additional comments (1)

docs/router/config.json (1)

36-39: ✓ Navigation entry is properly formatted and consistent.

The new "Comparison" item is correctly added to the React framework's Getting Started section with proper JSON structure, consistent naming conventions, and logical placement. The path framework/react/comparison follows the established pattern, and the target documentation file exists at the expected location.

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

nx-cloud · 2025-10-17T04:02:27Z

View your CI Pipeline Execution ↗ for commit e405b14

Command	Status	Duration	Result
`nx affected --targets=test:eslint,test:unit,tes...`	✅ Succeeded	<1s	View ↗
`nx run-many --target=build --exclude=examples/*...`	✅ Succeeded	2s	View ↗

☁️ Nx Cloud last updated this comment at 2025-10-17 04:04:52 UTC

pkg-pr-new · 2025-10-17T04:03:35Z

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@5503

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@5503

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@5503

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@5503

@tanstack/nitro-v2-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/nitro-v2-vite-plugin@5503

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@5503

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@5503

@tanstack/react-router-ssr-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-ssr-query@5503

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@5503

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@5503

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@5503

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@5503

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@5503

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@5503

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@5503

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@5503

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@5503

@tanstack/router-ssr-query-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-ssr-query-core@5503

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@5503

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@5503

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@5503

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@5503

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@5503

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@5503

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@5503

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@5503

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@5503

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@5503

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@5503

@tanstack/start-static-server-functions

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-static-server-functions@5503

@tanstack/start-storage-context

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-storage-context@5503

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@5503

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@5503

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@5503

commit: e405b14

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

docs/router/framework/react/comparison.md (1)
12-19: Enhance the feature key formatting for clarity.

The feature key is useful, but the list items could be formatted more clearly with markdown list syntax for better readability and consistency with the rest of the documentation. Consider using proper list formatting:
-Feature/Capability Key:
-
-- ✅ 1st-class, built-in, and ready to use with no added configuration or code
-- 🟡 Partial Support (on a scale of 5)
-- 🟠 Supported via addon/community package
-- 🔶 Possible, but requires custom code/implementation/casting
-- 🛑 Not officially supported
+## Feature/Capability Key
+
+- **✅** 1st-class, built-in, and ready to use with no added configuration or code
+- **🟡** Partial Support (on a scale of 5)
+- **🟠** Supported via addon/community package
+- **🔶** Possible, but requires custom code/implementation/casting
+- **🛑** Not officially supported

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between be6c094 and 9940112.

📒 Files selected for processing (3)

docs/router/framework/react/comparison.md (1 hunks)
docs/router/framework/react/overview.md (0 hunks)
docs/router/framework/solid/overview.md (0 hunks)

💤 Files with no reviewable changes (2)

docs/router/framework/react/overview.md
docs/router/framework/solid/overview.md

🧰 Additional context used

📓 Path-based instructions (2)

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

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

docs/router/framework/react/comparison.md

docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

docs/router/framework/react/comparison.md

🪛 LanguageTool

docs/router/framework/react/comparison.md

[grammar] ~14-~14: There might be a mistake here.
Context: ... use with no added configuration or code - 🟡 Partial Support (on a scale of 5) - ?...

(QB_NEW_EN)

[grammar] ~15-~15: There might be a mistake here.
Context: ...e - 🟡 Partial Support (on a scale of 5) - 🟠 Supported via addon/community package...

(QB_NEW_EN)

[grammar] ~16-~16: There might be a mistake here.
Context: ...🟠 Supported via addon/community package - 🔶 Possible, but requires custom code/im...

(QB_NEW_EN)

[grammar] ~17-~17: There might be a mistake here.
Context: ...uires custom code/implementation/casting - 🛑 Not officially supported | ...

(QB_NEW_EN)

[grammar] ~18-~18: There might be a mistake here.
Context: ...on/casting - 🛑 Not officially supported | ...

(QB_NEW_EN)

[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: "_"