Skip to content

docs(framework/*/devtools): describe the 'Key' filter scope by what it matches instead of the row text - #12551

Merged
sukvvon merged 1 commit into
mainfrom
docs/devtools-key-filter-scope-wording
Nov 7, 2026
Merged

sukvvon merged 1 commit into
mainfrom
docs/devtools-key-filter-scope-wording

Conversation

@sukvvon

@sukvvon sukvvon commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

🎯 Changes

The Filter queries and mutations section said that the filter matches the text shown in each row, but query rows also show the observer count and the disabled and static indicators, which the Key scope doesn't match.

  • State that the filter uses the Key scope by default.
  • Describe Key as matching the query hash, or the mutation key and submission time, instead of what the list shows for each row.
  • Apply the same wording to the angular, preact, react, solid, svelte and vue devtools docs.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I have followed the AI contribution policy and 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).

Summary by CodeRabbit

  • Documentation
    • Clarified that DevTools filtering defaults to Key, which searches query hashes or mutation keys and submission times—not the text displayed in each row.
    • Clarified how Data and All scopes work in applicable framework guides.

@sukvvon sukvvon self-assigned this Nov 7, 2026
@changeset-bot

changeset-bot Bot commented Nov 7, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 7c2633e

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

@nx-cloud

nx-cloud Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 7c2633e

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 57s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-11-07 08:48:09 UTC

@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new

pkg-pr-new Bot commented Nov 7, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@12551

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@12551

@tanstack/lit-query

npm i https://pkg.pr.new/@tanstack/lit-query@12551

@tanstack/preact-query

npm i https://pkg.pr.new/@tanstack/preact-query@12551

@tanstack/preact-query-devtools

npm i https://pkg.pr.new/@tanstack/preact-query-devtools@12551

@tanstack/preact-query-persist-client

npm i https://pkg.pr.new/@tanstack/preact-query-persist-client@12551

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@12551

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@12551

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@12551

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@12551

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@12551

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@12551

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@12551

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@12551

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@12551

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@12551

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@12551

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@12551

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@12551

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@12551

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@12551

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@12551

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@12551

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@12551

commit: 7c2633e

@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.85 KB (0%)
react minimal 8.67 KB (0%)

@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The Angular, Preact, React, Solid, Svelte, and Vue Devtools guides now describe Key as the default filter scope. They specify that Key matches query hashes or mutation keys and submission times.

Changes: Devtools filter documentation

Layer / File(s) Summary
Document the default Key scope
docs/framework/angular/devtools.md, docs/framework/preact/devtools.md, docs/framework/react/devtools.md, docs/framework/solid/devtools.md, docs/framework/svelte/devtools.md, docs/framework/vue/devtools.md
The guides identify Key as the default scope and describe its matches as query hashes or mutation keys and submission times.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

Suggested reviewers: grzdev

Merge Risk: Minimal · up to 7c263

The guides clarify the default filter scope and what it matches. No actionable merge-blocking risk is identified; the change is ready to merge subject to normal checks.

Pre-merge checks: Passed 5

Check name Status Explanation
Title check Passed The title describes the main documentation change and identifies the affected filter scope.
Description check Passed The description includes the changes, motivation, checklist, and release impact. The testing item remains unchecked.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (6 skipped: 6 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between cb755b9 and 7c2633e.

Files selected for processing: 6

  • docs/framework/angular/devtools.md
  • docs/framework/preact/devtools.md
  • docs/framework/react/devtools.md
  • docs/framework/solid/devtools.md
  • docs/framework/svelte/devtools.md
  • docs/framework/vue/devtools.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 3 remain after this review.

@sukvvon
sukvvon merged commit 5174c71 into main Nov 7, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/devtools-key-filter-scope-wording branch November 7, 2026 08:55
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