docs: install the framework adapters as dev dependencies everywhere by AlemTuzlak · Pull Request #547 · TanStack/devtools · GitHub
Skip to content

docs: install the framework adapters as dev dependencies everywhere - #547

Open
AlemTuzlak wants to merge 1 commit into
mainfrom
docs/227-install-dev-dependency
Open

AlemTuzlak wants to merge 1 commit into
mainfrom
docs/227-install-dev-dependency

Conversation

@AlemTuzlak

Copy link
Copy Markdown
Collaborator

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.md and most of quick-start.md already used -D.
  • The adapter pages, the basic setup pages (React, Preact, Solid, Vue, Svelte, Angular), and the Svelte and Angular quick start used a regular install. They now use -D.
  • installation.md now says to install as a dev dependency, with a link to its Production Builds section.
  • The @tanstack/devtools-event-client and @tanstack/devtools-utils installs stay regular, because library and plugin code use them at runtime.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 Release Impact

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

Testing

Commands run

  • prettier --check on the changed docs: pass.
  • grep for adapter install lines without -D in docs/: none left.

Manual test

  1. Open the three pages from Install as dev dependency or regular dependency? #227: Installation, Quick Start, and the React adapter.
  2. Make sure that all three use 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

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
@coderabbitai

coderabbitai Bot commented Oct 2, 2026

Copy link
Copy Markdown

@nx-cloud

nx-cloud Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 17638c2

Command Status Duration Result
nx run-many --target=test:e2e --parallel=1 --pr... ✅ Succeeded 1m 15s View ↗
nx affected --targets=test:eslint,test:sherif,t... ✅ Succeeded 6s View ↗
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-02 14:03:12 UTC

@nx-cloud

nx-cloud Bot commented Oct 2, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 17638c2

Command Status Duration Result
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-10-02 14:01:27 UTC

@pkg-pr-new

pkg-pr-new Bot commented Oct 2, 2026

Copy link
Copy Markdown

This branch has not been deployed

No deployments
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.

Install as dev dependency or regular dependency?

1 participant