Skip to content

fix(docs): update input docs#6810

Open
irsooti wants to merge 1 commit intoTanStack:mainfrom
irsooti:patch-1
Open

fix(docs): update input docs#6810
irsooti wants to merge 1 commit intoTanStack:mainfrom
irsooti:patch-1

Conversation

@irsooti
Copy link

@irsooti irsooti commented Mar 3, 2026

When I run the current quickstart commands, I see this warning:

Warning: @tanstack/create-start is deprecated. Use "tanstack create" or "npx @tanstack/cli create" instead.
         See: https://tanstack.com/start/latest/docs/framework/react/quick-start

I’ve updated the quickstart documentation accordingly.

Summary by CodeRabbit

  • Documentation
    • Updated the Quick Start command in the React framework guide to reflect the current installation method.

@github-actions github-actions bot added the documentation Everything documentation related label Mar 3, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2217f7c and 5597594.

📒 Files selected for processing (1)
  • docs/start/framework/react/quick-start.md

📝 Walkthrough

Walkthrough

The React Quick Start documentation is updated to recommend using npx @tanstack/cli create instead of npm create @tanstack/start@latest for initializing new projects. This reflects a change in the preferred CLI tool and command pattern.

Changes

Cohort / File(s) Summary
Documentation
docs/start/framework/react/quick-start.md
Updated project initialization command from npm create @tanstack/start@latest to npx @tanstack/cli create.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • docs: quickstart #5286: Similar quick-start documentation update changing the recommended CLI command for project creation.

Suggested labels

documentation

Suggested reviewers

  • brenelz

Poem

🐰 A cli command, swift and new,
Makes starting projects fresh and true,
No npm create, just npx's way,
Quick-start shines brighter every day! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix(docs): update input docs' is vague and generic, referring to 'input docs' without specifying which documentation or what update was made. The actual change updates the Quick Start command from a deprecated approach to npx @tanstack/cli create, but this specificity is absent from the title. Use a more specific title like 'fix(docs): update Quick Start to use npx @tanstack/cli create' to clearly indicate which documentation section and what specific change was made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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
Copy link

nx-cloud bot commented Mar 3, 2026

View your CI Pipeline Execution ↗ for commit 5597594

Command Status Duration Result
nx run @benchmarks/bundle-size:build --outputSt... ✅ Succeeded 1m 26s View ↗

☁️ Nx Cloud last updated this comment at 2026-03-03 16:25:06 UTC

@github-actions
Copy link

github-actions bot commented Mar 3, 2026

Bundle Size Benchmarks

  • Commit: 2217f7c3f19f
  • Measured at: 2026-03-03T16:24:12.219Z
  • Baseline source: history:2217f7c3f19f
  • Dashboard: bundle-size history
Scenario Current (gzip) Delta vs baseline Raw Brotli Trend
react-router.minimal 86.58 KiB 0 B (0.00%) 272.45 KiB 75.22 KiB ▅▅▅▅▅▅▅▅▅▅▅
react-router.full 89.61 KiB 0 B (0.00%) 282.78 KiB 77.90 KiB ▅▅▅▅▅▅▅▅▅▅▅
solid-router.minimal 35.88 KiB 0 B (0.00%) 107.56 KiB 32.26 KiB ▅▅▅▅▅▅▅▅▅▅▅
solid-router.full 40.21 KiB 0 B (0.00%) 120.61 KiB 36.13 KiB ▅▅▅▅▅▅▅▅▅▅▅
vue-router.minimal 51.75 KiB 0 B (0.00%) 147.54 KiB 46.50 KiB ▅▅▅▅▅▅▅▅▅▅▅
vue-router.full 56.55 KiB 0 B (0.00%) 163.12 KiB 50.86 KiB ▅▅▅▅▅▅▅▅▅▅▅
react-start.minimal 99.11 KiB 0 B (0.00%) 311.58 KiB 85.68 KiB ▅▅▅▅▅▅▅▅▅▅▅
react-start.full 102.50 KiB 0 B (0.00%) 321.39 KiB 88.63 KiB ▁▁▁████████
solid-start.minimal 48.19 KiB 0 B (0.00%) 145.13 KiB 42.67 KiB ▅▅▅▅▅▅▅▅▅▅▅
solid-start.full 53.68 KiB 0 B (0.00%) 161.08 KiB 47.37 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.

1 participant