Skip to content

docs(framework/vue/devtools): correct 'your React app' typo to 'your Vue app' in the Embedded Mode section#10854

Merged
sukvvon merged 1 commit into
mainfrom
docs/framework-vue-devtools-embedded-mode-typo
Jun 1, 2026
Merged

docs(framework/vue/devtools): correct 'your React app' typo to 'your Vue app' in the Embedded Mode section#10854
sukvvon merged 1 commit into
mainfrom
docs/framework-vue-devtools-embedded-mode-typo

Conversation

@sukvvon
Copy link
Copy Markdown
Collaborator

@sukvvon sukvvon commented Jun 1, 2026

🎯 Changes

The Vue devtools ## Embedded Mode section instructs users to place the code "as high in your React app as you can", which is a copy-paste leftover from the original React docs. Vue users should be told to place it in their Vue app.

-Place the following code as high in your React app as you can. The closer it is to the root of the page, the better it will work!
+Place the following code as high in your Vue app as you can. The closer it is to the root of the page, the better it will work!

Found while comparing the Embedded Mode sections across all four adapter docs in #10853. React, Preact, and Solid already say "your app" correctly.

✅ 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
    • Corrected framework reference in Embedded Mode instructions documentation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 026cee6e-8e8a-4257-beef-710c1a3fcdef

📥 Commits

Reviewing files that changed from the base of the PR and between 1b4e731 and af6a96b.

📒 Files selected for processing (1)
  • docs/framework/vue/devtools.md

📝 Walkthrough

Walkthrough

This PR corrects a single-line documentation error in the Vue devtools guide. The Embedded Mode section incorrectly referenced placing code in a React app instead of a Vue app, which is now fixed to match the Vue framework context.

Changes

Vue Devtools Documentation Framework Reference

Layer / File(s) Summary
Embedded Mode framework reference correction
docs/framework/vue/devtools.md
The Embedded Mode section text is corrected to reference "Vue app" instead of "React app" for accurate framework alignment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • TanStack/query#10853: Adds Embedded Mode documentation for other frameworks and modifies the same devtools documentation structure.

Poem

🐰 A Vue app, not React, we now declare,
Framework names fixed with utmost care,
One little line, a typo's farewell,
Docs shine brighter, clarity's knell! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: correcting a typo in Vue devtools documentation where 'React app' was incorrectly referenced instead of 'Vue app' in the Embedded Mode section.
Description check ✅ Passed The description follows the template structure with a clear 'Changes' section explaining the typo fix, a completed checklist confirming contribution guidelines and local testing, and proper Release Impact selection marking it as docs-only.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/framework-vue-devtools-embedded-mode-typo

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

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Jun 1, 2026

View your CI Pipeline Execution ↗ for commit af6a96b

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

☁️ Nx Cloud last updated this comment at 2026-06-01 06:26:06 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟩 Patch bumps

Package Version Reason
@tanstack/lit-query 0.2.6 → 0.2.7 Changeset
@tanstack/query-devtools 5.100.14 → 5.100.15 Changeset
@tanstack/angular-query-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/angular-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/eslint-plugin-query 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/preact-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/query-async-storage-persister 5.100.14 → 5.100.15 Dependent
@tanstack/query-broadcast-client-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/query-core 5.100.14 → 5.100.15 Dependent
@tanstack/query-persist-client-core 5.100.14 → 5.100.15 Dependent
@tanstack/query-sync-storage-persister 5.100.14 → 5.100.15 Dependent
@tanstack/react-query 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-next-experimental 5.100.14 → 5.100.15 Dependent
@tanstack/react-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query-devtools 5.100.14 → 5.100.15 Dependent
@tanstack/solid-query-persist-client 5.100.14 → 5.100.15 Dependent
@tanstack/svelte-query 6.1.33 → 6.1.34 Dependent
@tanstack/svelte-query-devtools 6.1.33 → 6.1.34 Dependent
@tanstack/svelte-query-persist-client 6.1.33 → 6.1.34 Dependent
@tanstack/vue-query 5.100.14 → 5.100.15 Dependent
@tanstack/vue-query-devtools 6.1.33 → 6.1.34 Dependent

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jun 1, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: af6a96b

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

size-limit report 📦

Path Size
react full 12.11 KB (0%)
react minimal 9.08 KB (0%)

@sukvvon sukvvon self-assigned this Jun 1, 2026
@sukvvon sukvvon merged commit a79fc8d into main Jun 1, 2026
9 checks passed
@sukvvon sukvvon deleted the docs/framework-vue-devtools-embedded-mode-typo branch June 1, 2026 06:27
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