Uh oh!
There was an error while loading. Please reload this page.
docs: fix router commands in quick-start - #5499
Merged
Merged
Conversation
Contributor
WalkthroughUpdated React quick-start documentation: installation commands across package managers now reference Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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. Comment |
Contributor
View your CI Pipeline Execution ↗ for commit a5b1e95
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/arktype-adapter@tanstack/directive-functions-plugin@tanstack/eslint-plugin-router@tanstack/history@tanstack/nitro-v2-vite-plugin@tanstack/react-router@tanstack/react-router-devtools@tanstack/react-router-ssr-query@tanstack/react-start@tanstack/react-start-client@tanstack/react-start-server@tanstack/router-cli@tanstack/router-core@tanstack/router-devtools@tanstack/router-devtools-core@tanstack/router-generator@tanstack/router-plugin@tanstack/router-ssr-query-core@tanstack/router-utils@tanstack/router-vite-plugin@tanstack/server-functions-plugin@tanstack/solid-router@tanstack/solid-router-devtools@tanstack/solid-start@tanstack/solid-start-client@tanstack/solid-start-server@tanstack/start-client-core@tanstack/start-plugin-core@tanstack/start-server-core@tanstack/start-static-server-functions@tanstack/start-storage-context@tanstack/valibot-adapter@tanstack/virtual-file-routes@tanstack/zod-adaptercommit: |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/router/framework/react/quick-start.md(1 hunks)
🧰 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/quick-start.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/quick-start.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Preview
Comment on lines
+32
to
+40
| npm install @tanstack/react-router | ||
| # or | ||
| pnpm add @tanstack/router | ||
| pnpm add @tanstack/react-router | ||
| #or | ||
| yarn add @tanstack/router | ||
| yarn add @tanstack/react-router | ||
| # or | ||
| bun add @tanstack/router | ||
| bun add @tanstack/react-router | ||
| # or | ||
| deno add npm:@tanstack/router | ||
| deno add npm:@tanstack/react-router |
Contributor
There was a problem hiding this comment.
Fix the lingering package name mismatch.
The install commands correctly use @tanstack/react-router, but Line 45 still tells readers to check for @tanstack/router, undoing the fix and confusing the quick-start flow. Update that reference to @tanstack/react-router as well.
-Once installed, you can verify the installation by checking your `package.json` file for the `@tanstack/router` dependency.+Once installed, you can verify the installation by checking your `package.json` file for the `@tanstack/react-router` dependency.Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/router/framework/react/quick-start.md around lines 32 to 40 (and
specifically line 45), the install commands use @tanstack/react-router but the
later reference still mentions @tanstack/router; update that lingering package
name to @tanstack/react-router so the docs consistently reference the correct
package name and avoid confusion.
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As per #5443 (comment) -> fixing the commands
(Thanks for pointing it out @brett-lovelytics)
Summary by CodeRabbit