Conversation
…to match the actual rendered component
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughDocumentation and JSDoc comments were updated to standardize references to the devtools open/close control as the “TanStack” logo and to correct framework-specific panel naming. No runtime code, exported types, or behavior were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
github-actions
Bot
added
the
documentation
|
View your CI Pipeline Execution ↗ for commit a7323c8
☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview6 package(s) bumped directly, 18 bumped as dependents. 🟩 Patch bumps
|
Contributor
size-limit report 📦
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/framework/vue/devtools.md`:
- Around line 68-73: Update the remaining framework name in the options block by
replacing the incorrect phrase "React Query devtools panel" with "Vue Query
devtools panel" where the `position` option is documented; ensure the text that
follows the `position?: "top" | "bottom" | "left" | "right"` option now reads
that it defaults to `bottom` and describes the position of the Vue Query
devtools panel to match the surrounding Vue-specific documentation for
`buttonPosition` and `position`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c58c6718-22eb-49eb-9fb2-b053446916ef
📒 Files selected for processing (4)
docs/framework/preact/devtools.mddocs/framework/react/devtools.mddocs/framework/solid/devtools.mddocs/framework/vue/devtools.md
sukvvon
changed the title
…and use adapter naming for 'devtools panel' in JSDoc
sukvvon
changed the title
sukvvon
changed the title
…nPosition' union alignment
…o-with-tanstack-logo
sukvvon
changed the title
sukvvon
deleted the
docs/devtools-replace-framework-specific-logo-with-tanstack-logo
branch
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
🎯 Changes
Align devtools descriptions across both docs and JSDoc to match the actual rendered component, adapter naming, and full type union:
Replace framework-specific logo with
TanStack logoinbuttonPositiondescriptions across React, Vue, Solid, Preact docs and React, Vue, Solid, Svelte JSDoc.<TanstackLogo />component (packages/query-devtools/src/Devtools.tsx:263, 271) is the only logo rendered in the floating button, regardless of adapter — there's no customization API for it.TanStack logophrasing.Use adapter naming for
devtools panelinpositiondescriptions where it was inconsistent.React Query devtools panelleftover from copy-paste. Vue docs had the same leftover.TanStack Query devtools panel) instead of their adapter name, while their own docs already used the adapter name.{Framework} Query devtools panel(matching what users actually import:<VueQueryDevtoolsPanel />,<SolidQueryDevtoolsPanel />, etc.).Add missing union descriptions to JSDoc for full type coverage:
buttonPosition— added'relative'to React, Vue, Solid, Preact, Svelte JSDoc (5 adapters). TheDevtoolsButtonPositiontype already includes'relative', but JSDoc had the outdated 4-union. Angular JSDoc was the only one already correct.position— added the 4-union to Preact JSDoc (the only adapter that was missing it; others already had it).CodeRabbit's review on the original PR caught the Vue panel leftover; expanding the scope keeps the wording consistent across docs and JSDoc.
✅ Checklist
pnpm run test:pr.🚀 Release Impact