docs(solid-query): add summaries to reference pages that render without a description by sukvvon · Pull Request #11554 · TanStack/query

sukvvon · 2026-09-20T05:44:35Z

🎯 Changes

useQuery and useMutation document every parameter and carry an @example, but their JSDoc opened with a tag (@see and @param respectively), so TypeDoc had no summary to render and both reference pages started straight at a heading.

Each gained one leading sentence; the existing tags are untouched:

useMutation reuses the sentence already shared by the React, Preact and Vue adapters, with "hook" written as "function" — the Solid docs rewrite that word via replace: { 'hook': 'function' }, so the adapter doesn't call these hooks.
useQuery gets a sentence written for this adapter. The other adapters have no shared summary to match here: their documented overload only states the initialData condition, and Vue and Angular describe their own reactivity on top of it.

The initialData overload of useQuery already had a summary and is unchanged.

Generated docs

pnpm run generate-docs updates 4 pages from these 2 source changes: functions/useQuery.md and functions/useMutation.md, plus variables/createQuery.md and variables/createMutation.md — the createX aliases inherit the JSDoc of the function they alias, so they pick up the summary too. The 3 deleted lines are Defined in: line-number shifts.

✅ 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 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
- Added consistent descriptions for queries, including their unique keys, asynchronous data sources, execution conditions, and the effect of enabled: false on initial fetching.
- Clarified mutation documentation, including typical uses such as creating, updating, or deleting data and performing server-side effects.
- Updated source links in the query and mutation API references to point to the current definitions.

coderabbitai · 2026-09-20T05:44:56Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: TanStack/query/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 81295048-c9bf-4d32-91e5-aa0ea58a8baf

📥 Commits

Reviewing files that changed from the base of the PR and between 38fdef8 and 05e720d.

📒 Files selected for processing (3)

docs/framework/solid/reference/functions/useQuery.md
docs/framework/solid/reference/variables/createQuery.md
packages/solid-query/src/useQuery.ts

🚧 Files skipped from review as they are similar to previous changes (3)

packages/solid-query/src/useQuery.ts
docs/framework/solid/reference/variables/createQuery.md
docs/framework/solid/reference/functions/useQuery.md

Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Walkthrough

Walkthrough

The PR adds Solid query and mutation behavior descriptions to source documentation and reference pages. It also updates useQuery and useMutation source links to the new line numbers.

Changes

Solid API documentation

Layer / File(s)	Summary
API behavior documentation `packages/solid-query/src/useMutation.ts`, `packages/solid-query/src/useQuery.ts`	The JSDoc describes mutation usage and query subscription behavior, including unique keys, option-controlled execution, and `enabled: false` skipping the initial fetch.
Reference page updates `docs/framework/solid/reference/functions/`, `docs/framework/solid/reference/variables/`	The reference pages add matching query and mutation descriptions. The `useQuery` and `useMutation` pages update their source links.

Priority: ⬇️ Low

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

Change: Other

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main documentation change: adding summaries to Solid Query reference pages.
Description check	✅ Passed	The description includes the required Changes, Checklist, and Release Impact sections. It explains the motivation, generated documentation updates, testing status, and documentation-only release impac…
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2…
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.

✨ Finishing Touches

📝 Generate docstrings

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

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

_{Comment @coderabbitai help to get the list of available commands.}

nx-cloud · 2026-09-20T05:45:00Z

View your CI Pipeline Execution ↗ for commit 05e720d

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

☁️ Nx Cloud last updated this comment at 2026-09-20 16:41:15 UTC

github-actions · 2026-09-20T05:45:39Z

🚀 Changeset Version Preview

1 package(s) bumped directly, 24 bumped as dependents.

🟩 Patch bumps

Package	Version	Reason
`@tanstack/query-core`	5.103.1 → 5.103.2	Changeset
`@tanstack/angular-query-experimental`	5.103.1 → 5.103.2	Dependent
`@tanstack/angular-query-persist-client`	5.103.1 → 5.103.2	Dependent
`@tanstack/eslint-plugin-query`	5.103.1 → 5.103.2	Dependent
`@tanstack/lit-query`	0.2.22 → 0.2.23	Dependent
`@tanstack/preact-query`	5.103.1 → 5.103.2	Dependent
`@tanstack/preact-query-devtools`	5.103.1 → 5.103.2	Dependent
`@tanstack/preact-query-persist-client`	5.103.1 → 5.103.2	Dependent
`@tanstack/query-async-storage-persister`	5.103.1 → 5.103.2	Dependent
`@tanstack/query-broadcast-client-experimental`	5.103.1 → 5.103.2	Dependent
`@tanstack/query-devtools`	5.103.1 → 5.103.2	Dependent
`@tanstack/query-persist-client-core`	5.103.1 → 5.103.2	Dependent
`@tanstack/query-sync-storage-persister`	5.103.1 → 5.103.2	Dependent
`@tanstack/react-query`	5.103.1 → 5.103.2	Dependent
`@tanstack/react-query-devtools`	5.103.1 → 5.103.2	Dependent
`@tanstack/react-query-next-experimental`	5.103.1 → 5.103.2	Dependent
`@tanstack/react-query-persist-client`	5.103.1 → 5.103.2	Dependent
`@tanstack/solid-query`	5.103.1 → 5.103.2	Dependent
`@tanstack/solid-query-devtools`	5.103.1 → 5.103.2	Dependent
`@tanstack/solid-query-persist-client`	5.103.1 → 5.103.2	Dependent
`@tanstack/svelte-query`	6.2.1 → 6.2.2	Dependent
`@tanstack/svelte-query-devtools`	6.2.1 → 6.2.2	Dependent
`@tanstack/svelte-query-persist-client`	6.2.1 → 6.2.2	Dependent
`@tanstack/vue-query`	5.103.1 → 5.103.2	Dependent
`@tanstack/vue-query-devtools`	6.2.1 → 6.2.2	Dependent

pkg-pr-new · 2026-09-20T05:47:06Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 05e720d

github-actions · 2026-09-20T05:47:22Z

size-limit report 📦

Path	Size
react full	11.87 KB (0%)
react minimal	8.85 KB (0%)

…ut a description

sukvvon self-assigned this Sep 20, 2026

sukvvon force-pushed the docs/solid-query-reference-summaries branch 2 times, most recently from 35ea0b4 to 38fdef8 Compare September 20, 2026 06:00

docs(solid-query): add summaries to reference pages that render witho…

05e720d

…ut a description

sukvvon force-pushed the docs/solid-query-reference-summaries branch from 38fdef8 to 05e720d Compare September 20, 2026 16:37

sukvvon merged commit 3b45ebc into main Sep 20, 2026
9 checks passed

sukvvon deleted the docs/solid-query-reference-summaries branch September 20, 2026 16:47

Navigation Menu

Uh oh!

docs(solid-query): add summaries to reference pages that render without a description - #11554

docs(solid-query): add summaries to reference pages that render without a description#11554
sukvvon merged 1 commit into
mainfrom
docs/solid-query-reference-summaries

sukvvon commented Sep 20, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Sep 20, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Sep 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 20, 2026

Uh oh!

pkg-pr-new Bot commented Sep 20, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Sep 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

sukvvon commented Sep 20, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

Generated docs

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Sep 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

nx-cloud Bot commented Sep 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 20, 2026

🚀 Changeset Version Preview

🟩 Patch bumps

Uh oh!

pkg-pr-new Bot commented Sep 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 20, 2026

size-limit report 📦

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Sep 20, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 20, 2026 •

edited

Loading

nx-cloud Bot commented Sep 20, 2026 •

edited

Loading

pkg-pr-new Bot commented Sep 20, 2026 •

edited

Loading