Skip to content

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

Open
sukvvon wants to merge 1 commit into
mainfrom
chore/generate-docs-drop-preact
Open

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

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 16, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

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

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

nx-cloud Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 1936431

Command Status Duration Result
nx run-many --target=build --exclude=examples/*... ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2026-08-16 19:42:09 UTC

@coderabbitai

coderabbitai Bot commented Aug 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

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: 86d54e8f-3d3e-4461-a7b1-fc4b1cba8ae7

📥 Commits

Reviewing files that changed from the base of the PR and between 6423f9e and 1936431.

📒 Files selected for processing (1)
  • scripts/generate-docs.ts
💤 Files with no reviewable changes (1)
  • scripts/generate-docs.ts

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

📝 Walkthrough

Walkthrough

The documentation generation script no longer generates Preact reference documentation.

Changes

Cohort / File(s) Summary
Documentation generation
scripts/generate-docs.ts		 Removes Preact from the documentation generation list.

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

Merge Risk: ⚪ Minimal · up to 19364

This change only stops generating TypeDoc reference output for preact-query and is limited to documentation tooling; no actionable merge-blocking risk remains after normal checks and review.

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: removing preact-query from TypeDoc generation targets.
Description check ✅ Passed The description includes all required sections, explains the motivation, confirms testing, and identifies the change 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.
✨ 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

github-actions Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@sukvvon sukvvon mentioned this pull request Aug 16, 2026
Draft
4 tasks
@sukvvon sukvvon self-assigned this Aug 16, 2026
@pkg-pr-new

pkg-pr-new Bot commented Aug 16, 2026

Copy link
Copy Markdown
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: 1936431

@github-actions

github-actions Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 12.15 KB (0%)
react minimal 9.1 KB (0%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@sukvvon sukvvon

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@sukvvon