chore(scripts/generate-docs): add 'react-query' to TypeDoc generation targets by sukvvon · Pull Request #11205 · TanStack/query

sukvvon · 2026-08-16T19:34:52Z

🎯 Changes

Adds react-query to the pkg array in scripts/generate-docs.ts, so react-query's reference docs can be generated by TypeDoc (mirroring the existing setup for angular-query-experimental, svelte-query, preact-query, and lit-query).

This is the next step after #11204, which ported the hand-written React reference docs into preact-query's JSDoc and validated that TypeDoc's output holds up against the actual types with minimal loss of information. This PR applies the same approach to react-query itself.

Still a draft: the script change alone is enough to review, but merging it means the next pnpm run generate-docs run will wipe and regenerate docs/framework/react/reference/, which currently holds the hand-written docs. That requires porting the same JSDoc into react-query's source first (the actual react-query equivalent of #11204) — this PR isn't wired up to run yet.

Options inherited from query-core (e.g. staleTime, retry, gcTime) remain out of scope — generate-docs.ts excludes query-core from all TypeDoc entry points, so that's a separate follow-up.

✅ 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).

…tion targets

nx-cloud · 2026-08-16T19:35:17Z

View your CI Pipeline Execution ↗ for commit 22e2d44

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

☁️ Nx Cloud last updated this comment at 2026-08-24 17:48:33 UTC

coderabbitai · 2026-08-16T19:35:19Z

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4fae9b11-4f3e-444f-801a-a4be16841d61

📥 Commits

Reviewing files that changed from the base of the PR and between c9dba07 and 4234ae7.

📒 Files selected for processing (1)

scripts/generate-docs.ts

💤 Files with no reviewable changes (1)

scripts/generate-docs.ts

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

📝 Walkthrough

Walkthrough

The documentation generation script no longer generates Preact reference documentation.

Changes

Documentation generation

Layer / File(s)	Summary
Remove Preact reference docs `scripts/generate-docs.ts`	Removes the Preact package configuration from the documentation generation list.

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

Merge Risk: ⚪ Minimal · up to 4234a

This change stops automatic TypeDoc generation for preact-query so manually authored reference documentation is preserved; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title says the PR adds react-query, but the changes remove preact-query from the TypeDoc generation targets.	Update the title to state that preact-query was removed from the TypeDoc generation targets.
Description check	⚠️ Warning	The description is well structured but describes adding react-query, while the actual PR removes preact-query from the generation targets.	Rewrite the description to document the removal of preact-query and explain its documentation-generation impact.

✅ Passed checks (3 passed)

Check name	Status	Explanation
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 0 files.
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

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch chore/generate-docs-drop-preact

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.}

github-actions · 2026-08-16T19:35:55Z

🚀 Changeset Version Preview

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

pkg-pr-new · 2026-08-16T19:41:57Z

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 22e2d44

github-actions · 2026-08-16T19:42:10Z

size-limit report 📦

Path	Size
react full	11.97 KB (0%)
react minimal	8.92 KB (0%)

coderabbitai · 2026-08-22T01:52:21Z

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

… targets

…c generation targets" This reverts commit 1936431.

…query'

chore(scripts/generate-docs): drop 'preact-query' from TypeDoc genera…

1936431

…tion targets

sukvvon requested a review from a team as a code owner August 16, 2026 19:34

sukvvon mentioned this pull request Aug 16, 2026

docs(preact-query): document functions and components with JSDoc for generated reference docs #11204

Open

4 tasks

sukvvon self-assigned this Aug 16, 2026

Merge branch 'main' into chore/generate-docs-drop-preact

4234ae7

sukvvon marked this pull request as draft August 24, 2026 09:41

sukvvon added 3 commits August 25, 2026 02:41

chore(scripts/generate-docs): add 'react-query' to TypeDoc generation…

897ccd5

… targets

Revert "chore(scripts/generate-docs): drop 'preact-query' from TypeDo…

9136b10

…c generation targets" This reverts commit 1936431.

chore(scripts/generate-docs): move 'react-query' entry above 'preact-…

529a58b

…query'

sukvvon changed the title ~~chore(scripts/generate-docs): drop 'preact-query' from TypeDoc generation targets~~ chore(scripts/generate-docs): add 'react-query' to TypeDoc generation targets Aug 24, 2026

Merge branch 'main' into chore/generate-docs-drop-preact

22e2d44

Navigation Menu

Uh oh!

Uh oh!

chore(scripts/generate-docs): add 'react-query' to TypeDoc generation targets - #11205

chore(scripts/generate-docs): add 'react-query' to TypeDoc generation targets#11205
sukvvon wants to merge 6 commits into
mainfrom
chore/generate-docs-drop-preact

sukvvon commented Aug 16, 2026 •

edited

Loading

Uh oh!

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

Draft PR not reviewed

Walkthrough

Changes

❌ Failed checks (2 warnings)

Uh oh!

github-actions Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

sukvvon commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Draft PR not reviewed

Walkthrough

Changes

❌ Failed checks (2 warnings)

Uh oh!

github-actions Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Changeset Version Preview

Uh oh!

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

Uh oh!

Uh oh!

github-actions Bot commented Aug 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

coderabbitai Bot commented Aug 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sukvvon commented Aug 16, 2026 •

edited

Loading

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

github-actions Bot commented Aug 16, 2026 •

edited

Loading

pkg-pr-new Bot commented Aug 16, 2026 •

edited

Loading

github-actions Bot commented Aug 16, 2026 •

edited

Loading