Skip to content

Update installation command for devtools to dev dependency#399

Open
danny-does-stuff wants to merge 2 commits intoTanStack:mainfrom
danny-does-stuff:patch-1
Open

Update installation command for devtools to dev dependency#399
danny-does-stuff wants to merge 2 commits intoTanStack:mainfrom
danny-does-stuff:patch-1

Conversation

@danny-does-stuff
Copy link

@danny-does-stuff danny-does-stuff commented Mar 18, 2026

🎯 Changes

add -D to install command in quick start to match the instructions on the installation page

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • [-] (N/A) I have tested this code locally with pnpm test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated devtools installation instructions: React, Preact, Solid, and Vue devtools (and their Vite plugins) are now shown as development dependencies (npm install -D).

@coderabbitai
Copy link

coderabbitai bot commented Mar 18, 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: f6171fe1-2e5a-4686-a9d0-de278449825c

📥 Commits

Reviewing files that changed from the base of the PR and between 11ef941 and 43e30f4.

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

📝 Walkthrough

Walkthrough

The quick-start documentation's npm install commands for React, Preact, Solid, and Vue devtools (and their Vite plugin variants) were changed to use npm install -D to mark them as development dependencies.

Changes

Cohort / File(s) Summary
Documentation
docs/quick-start.md
Converted npm install commands for React, Preact, Solid, and Vue devtools and their Vite plugins to use the -D flag (install as devDependencies).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny command, now dressed in D,
Dev tools tucked where devs expect to be.
Preact, Solid, Vue, and React too,
All snug in devDeps — a neat little crew. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: updating installation commands to include the -D flag for dev dependencies.
Description check ✅ Passed The description follows the required template with all sections completed. Changes are clearly explained, checklist items are marked appropriately, and release impact is correctly identified as docs-only.
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
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use oxc to improve the quality of JavaScript and TypeScript code reviews.

Add a configuration file to your project to customize how CodeRabbit runs oxc.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/quick-start.md`:
- Line 13: Update the Preact, Solid, and Vue installation commands to install
TanStack devtools as devDependencies like the React section: replace the
existing "npm install `@tanstack/react-devtools` `@tanstack/devtools-vite`" (or
similar) lines in the Preact, Solid, and Vue sections with "npm install -D ..."
so all framework sections consistently use the -D flag for devtools; check the
section headers "Preact", "Solid", and "Vue" to locate the exact lines to
change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1bd40f49-b4ac-4ee7-b220-bb5f838bb773

📥 Commits

Reviewing files that changed from the base of the PR and between 604c96d and 11ef941.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant