chore(scripts/generate-docs): drop 'preact-query' from TypeDoc generation targets by sukvvon · Pull Request #11205 · TanStack/query

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

🎯 Changes

Removes the preact-query entry from the pkg array in scripts/generate-docs.ts, so preact-query's reference docs are no longer generated by TypeDoc.

This is split out from #11204, which switches docs/framework/preact/reference/* to manually-authored files that ref: the React reference docs (the same convention vue-query uses). That PR depends on this one merging first — otherwise the next generate-docs run would overwrite the manually-authored files with TypeDoc output again.

✅ 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
- Removed Preact reference documentation from the documentation generation process.

…tion targets

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

View your CI Pipeline Execution ↗ for commit 4234ae7

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

☁️ Nx Cloud last updated this comment at 2026-08-22 01:55:37 UTC

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

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 | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description includes all required sections, explains the change and motivation, records testing, and identifies the change as docs-only.
Title check	✅ Passed	The title clearly and concisely describes removing preact-query from TypeDoc generation targets.
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

10 package(s) bumped directly, 15 bumped as dependents.

🟨 Minor bumps

Package	Version	Reason
`@tanstack/angular-query-experimental`	5.101.4 → 5.102.0	Changeset
`@tanstack/eslint-plugin-query`	5.101.4 → 5.102.0	Changeset
`@tanstack/preact-query`	5.101.4 → 5.102.0	Changeset
`@tanstack/query-broadcast-client-experimental`	5.101.4 → 5.102.0	Changeset
`@tanstack/query-core`	5.101.4 → 5.102.0	Changeset
`@tanstack/react-query`	5.101.4 → 5.102.0	Changeset
`@tanstack/solid-query`	5.101.4 → 5.102.0	Changeset
`@tanstack/vue-query`	5.101.4 → 5.102.0	Changeset
`@tanstack/angular-query-persist-client`	5.101.4 → 5.102.0	Dependent
`@tanstack/preact-query-devtools`	5.101.4 → 5.102.0	Dependent
`@tanstack/preact-query-persist-client`	5.101.4 → 5.102.0	Dependent
`@tanstack/query-async-storage-persister`	5.101.4 → 5.102.0	Dependent
`@tanstack/query-devtools`	5.101.4 → 5.102.0	Dependent
`@tanstack/query-persist-client-core`	5.101.4 → 5.102.0	Dependent
`@tanstack/query-sync-storage-persister`	5.101.4 → 5.102.0	Dependent
`@tanstack/react-query-devtools`	5.101.4 → 5.102.0	Dependent
`@tanstack/react-query-next-experimental`	5.101.4 → 5.102.0	Dependent
`@tanstack/react-query-persist-client`	5.101.4 → 5.102.0	Dependent
`@tanstack/solid-query-devtools`	5.101.4 → 5.102.0	Dependent
`@tanstack/solid-query-persist-client`	5.101.4 → 5.102.0	Dependent

🟩 Patch bumps

Package	Version	Reason
`@tanstack/lit-query`	0.2.11 → 0.2.12	Changeset
`@tanstack/svelte-query`	6.1.38 → 6.1.39	Changeset
`@tanstack/svelte-query-devtools`	6.1.38 → 6.1.39	Dependent
`@tanstack/svelte-query-persist-client`	6.1.38 → 6.1.39	Dependent
`@tanstack/vue-query-devtools`	6.1.38 → 6.1.39	Dependent

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: 4234ae7

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

size-limit report 📦

Path	Size
react full	11.98 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.

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/reference): switch to React reference reuse via 'ref:' like vue-query #11204

Draft

4 tasks

sukvvon self-assigned this Aug 16, 2026

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

4234ae7

Navigation Menu

Uh oh!

Uh oh!

chore(scripts/generate-docs): drop 'preact-query' from TypeDoc generation targets - #11205

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

sukvvon commented Aug 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

nx-cloud Bot commented Aug 16, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 16, 2026 •

edited

Loading

Walkthrough

Changes

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 by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

✅ Checklist

🚀 Release Impact

Summary by CodeRabbit

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!

Walkthrough

Changes

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

🟨 Minor bumps

🟩 Patch bumps

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 by coderabbitai Bot

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