Skip to content

docs({solid,vue}-query/broadcastQueryClient): remove unnecessary 'replace' that doesn't match source content#10193

Merged
TkDodo merged 1 commit intoTanStack:mainfrom
sukvvon:docs/fix-broadcastQueryClient-replace
Feb 26, 2026
Merged

docs({solid,vue}-query/broadcastQueryClient): remove unnecessary 'replace' that doesn't match source content#10193
TkDodo merged 1 commit intoTanStack:mainfrom
sukvvon:docs/fix-broadcastQueryClient-replace

Conversation

@sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Feb 26, 2026

🎯 Changes

Both solid-query and vue-query broadcastQueryClient.md docs had a replace: { 'react-query': '...' } pattern, but the referenced React source file (docs/framework/react/plugins/broadcastQueryClient.md) doesn't contain the string react-query anywhere — the package name is @tanstack/query-broadcast-client-experimental.

Additionally, the solid-query file had 'react-query': 'vue-query' which was an incorrect value copied from the vue-query file.

This PR removes the unnecessary replace field from both files.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run 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 documentation metadata in the Solid and Vue plugin guides.

@changeset-bot
Copy link

changeset-bot bot commented Feb 26, 2026

⚠️ No Changeset found

Latest commit: 93502a9

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 26, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3f30619 and 93502a9.

📒 Files selected for processing (2)
  • docs/framework/solid/plugins/broadcastQueryClient.md
  • docs/framework/vue/plugins/broadcastQueryClient.md
💤 Files with no reviewable changes (2)
  • docs/framework/vue/plugins/broadcastQueryClient.md
  • docs/framework/solid/plugins/broadcastQueryClient.md

📝 Walkthrough

Walkthrough

Two documentation files for plugin implementations had a front matter mapping directive removed that previously mapped react-query to vue-query. These are documentation-only changes with no code or behavioral impact.

Changes

Cohort / File(s) Summary
Documentation Front Matter Updates
docs/framework/solid/plugins/broadcastQueryClient.md, docs/framework/vue/plugins/broadcastQueryClient.md
Removed the replace: { 'react-query': 'vue-query' } mapping directive from front matter in both plugin documentation files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

documentation

Poem

🐰 A hop, a skip, a line removed,
From docs so fine, a mapping soothed,
No react-query shall mislead,
Just cleaner prose ahead! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: removing unnecessary 'replace' directives from documentation files that don't match the actual source content.
Description check ✅ Passed The description comprehensively covers all required sections: explains what changed and why, includes all checklist items (contributing guide followed, testing completed), and clarifies the release impact 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
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Feb 26, 2026

View your CI Pipeline Execution ↗ for commit 93502a9

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

☁️ Nx Cloud last updated this comment at 2026-02-26 15:50:25 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 26, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 93502a9

@TkDodo TkDodo merged commit 0da627b into TanStack:main Feb 26, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants