GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — docs: clarify setup provider requirements by bndnsmth · Pull Request #302 · TanStack/devtools

Conversation

bndnsmth commented Jan 4, 2026

Copy link

Copy Markdown

🎯 Changes

Setup docs currently imply you can place the tools in the root of your app. Clarify setup docs by making it clear the tools need to live inside and/or be configured with the appropriate providers for the libraries you're using.

✅ Checklist

I have followed the steps in the Contributing guide.
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).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions


          setup clarity

0bb912d

Copilot AI review requested due to automatic review settings

January 4, 2026 15:21

changeset-bot Bot commented Jan 4, 2026

Copy link

Copy Markdown

⚠️ No Changeset found

Latest commit: 0bb912d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Copilot started reviewing on behalf of bndnsmth

January 4, 2026 15:22

View session

Copilot AI reviewed

Jan 4, 2026

View reviewed changes

Copilot AI left a comment

Copy link

Copy Markdown

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Pull request overview

This PR clarifies the TanStack Devtools setup documentation by emphasizing that devtools must be rendered inside the appropriate provider tree (e.g., QueryClientProvider) for the plugins being used. The changes update code examples across all framework adapters to demonstrate proper provider nesting and show how to pass required props like the router instance.

Key changes:

Updated description to explicitly mention provider requirements
Modified code examples to show complete provider setup with QueryClientProvider and RouterProvider
Added router instance passing to TanStackRouterDevtoolsPanel where applicable

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File	Description
docs/quick-start.md	Updated examples to show QueryClientProvider wrapping and router setup with instance passing
docs/framework/solid/basic-setup.md	Added provider setup with QueryClient and Router configuration, showing proper nesting
docs/framework/react/basic-setup.md	Added provider setup with QueryClient and Router configuration, showing proper nesting
docs/framework/preact/basic-setup.md	Added provider setup attempting to show QueryClient and Router configuration (but references non-existent packages)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Comment thread

docs/framework/preact/basic-setup.md

Comment on lines +56 to +70

		const router = /* create or import your TanStack Router instance */

		render(
		<>
		<QueryClientProvider client={queryClient}>
		<App />

		<TanStackDevtools
		plugins={[
		{
		name: 'Your Plugin',
		render: <YourPluginComponent />,
		name: 'TanStack Query',
		render: <PreactQueryDevtoolsPanel />,
		},
		{
		name: 'TanStack Router',
		render: <TanStackRouterDevtoolsPanel router={router} />,

Copilot AI Jan 4, 2026

Copy link

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

The router variable is initialized with a comment placeholder but then used in the TanStackRouterDevtoolsPanel. Since '@tanstack/preact-router-devtools' doesn't exist, this entire router-related section should be removed or replaced with an appropriate example for Preact.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Copilot uses AI. Check for mistakes.

Comment thread

docs/framework/react/basic-setup.md

Comment on lines 18 to +35

		```tsx
		import { StrictMode } from 'react'
		import { createRoot } from 'react-dom/client'
		import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
		import { RouterProvider, createRouter } from '@tanstack/react-router'
		import { TanStackDevtools } from '@tanstack/react-devtools'

		import App from './App'
		import { routeTree } from './routeTree.gen'

		const queryClient = new QueryClient()
		const router = createRouter({ routeTree })

		createRoot(document.getElementById('root')!).render(
		<StrictMode>
		<App />

		<TanStackDevtools />
		<QueryClientProvider client={queryClient}>
		<RouterProvider router={router} />
		<TanStackDevtools />
		</QueryClientProvider>

Copilot AI Jan 4, 2026

Copy link

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

The first basic example now requires TanStack Router setup (routeTree.gen, createRouter, RouterProvider) even though users might only want to use TanStack Query. Consider showing a simpler example that only requires QueryClientProvider first, and then a second example that adds Router for users who need both.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Copilot uses AI. Check for mistakes.

Comment thread

docs/framework/solid/basic-setup.md

Comment on lines 18 to +34

		```tsx
		import { render } from 'solid-js/web'
		import { QueryClient, QueryClientProvider } from '@tanstack/solid-query'
		import { RouterProvider, createRouter } from '@tanstack/solid-router'
		import { TanStackDevtools } from '@tanstack/solid-devtools'

		import App from './App'
		import { routeTree } from './routeTree.gen'

		createRoot(document.getElementById('root')!).render(
		<StrictMode>
		<App />
		const queryClient = new QueryClient()
		const router = createRouter({ routeTree })

		render(() => (
		<QueryClientProvider client={queryClient}>
		<RouterProvider router={router} />
		<TanStackDevtools />
		</StrictMode>,
		)
		</QueryClientProvider>
		), document.getElementById('root')!)

Copilot AI Jan 4, 2026

Copy link

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

Copilot uses AI. Check for mistakes.

This branch has not been deployed

No deployments

Reviewers

Copilot code review Copilot

Copilot review effort

Applies to this pull request for everyone.Learn more about Copilot code review.

Copilot left review comments

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

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.

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.