docs: install the framework adapters as dev dependencies everywhere - #547
Open
AlemTuzlak wants to merge 1 commit into
Open
AlemTuzlak wants to merge 1 commit into
AlemTuzlak wants to merge 1 commit into
Conversation
The installation page and most of the quick start used `npm install -D`, but the adapter pages, the basic setup pages, and the Svelte and Angular quick start used a regular install. Every adapter install now uses -D, and the installation page says when to use a regular dependency instead. Fixes #227
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 1 minute. View limit detailsLimit details: You’ve used all 4 included reviews currently available. Review configuration: ⚙️ Run configurationConfiguration used: Repository: TanStack/devtools/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (14)
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 |
|
View your CI Pipeline Execution ↗ for commit 17638c2
☁️ Nx Cloud last updated this comment at |
|
View your CI Pipeline Execution ↗ for commit 17638c2
☁️ Nx Cloud last updated this comment at |
More templates
@tanstack/angular-devtools
@tanstack/devtools
@tanstack/devtools-a11y
@tanstack/devtools-bundler-core
@tanstack/devtools-client
@tanstack/devtools-rspack
@tanstack/devtools-ui
@tanstack/devtools-utils
@tanstack/devtools-vite
@tanstack/devtools-webmcp
@tanstack/devtools-event-bus
@tanstack/devtools-event-client
@tanstack/preact-devtools
@tanstack/react-devtools
@tanstack/solid-devtools
@tanstack/svelte-devtools
@tanstack/vue-devtools
commit: |
This branch has not been deployed
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The docs disagree on how to install the devtools: some pages use
npm install -D, and others use a regular install. This PR makes every framework adapter install use-D. The installation page now says in one line when to use a regular dependency instead.🎯 Changes
installation.mdand most ofquick-start.mdalready used-D.-D.installation.mdnow says to install as a dev dependency, with a link to its Production Builds section.@tanstack/devtools-event-clientand@tanstack/devtools-utilsinstalls stay regular, because library and plugin code use them at runtime.✅ Checklist
pnpm test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Testing
Commands run
prettier --checkon the changed docs: pass.grepfor adapter install lines without-Dindocs/: none left.Manual test
npm install -D @tanstack/react-devtools.How this PR makes testing easy
Docs only.
Linked issues
Fixes #227
Risk / rollback
None. Docs only. To undo, revert this PR.
🤖 Generated with Claude Code