Skip to content

docs: regenerate reference docs to fix stale content and Preact source links - #11189

Merged
sukvvon merged 1 commit into
mainfrom
docs/fix-preact-source-links
Aug 16, 2026
Merged

docs: regenerate reference docs to fix stale content and Preact source links#11189
sukvvon merged 1 commit into
mainfrom
docs/fix-preact-source-links

Conversation

@sukvvon

@sukvvon sukvvon commented Aug 16, 2026

Copy link
Copy Markdown
Member

🎯 Changes

Regenerate reference docs via pnpm run generate-docs to fix:

Verified this isn't a stale local install producing spurious diffs: ran pnpm install --frozen-lockfile (no changes) then pnpm run generate-docs again, and the working tree stayed clean — regeneration against the pinned toolchain is idempotent and reproduces this exact diff.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr. (docs-only change, no code/tests affected)

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

@sukvvon sukvvon self-assigned this Aug 16, 2026
@nx-cloud

nx-cloud Bot commented Aug 16, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 28091f2

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

☁️ Nx Cloud last updated this comment at 2026-08-16 05:17:32 UTC

@github-actions

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

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

@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 7c469060-c463-409e-8455-05f0a5c951fd

📥 Commits

Reviewing files that changed from the base of the PR and between c5f2999 and 28091f2.

📒 Files selected for processing (99)
  • docs/framework/angular/reference/functions/infiniteQueryOptions.md
  • docs/framework/angular/reference/functions/mutationOptions.md
  • docs/framework/angular/reference/functions/provideAngularQuery.md
  • docs/framework/angular/reference/functions/provideTanStackQuery.md
  • docs/framework/angular/reference/functions/queryOptions.md
  • docs/framework/angular/reference/interfaces/BaseMutationNarrowing.md
  • docs/framework/angular/reference/interfaces/BaseQueryNarrowing.md
  • docs/framework/angular/reference/interfaces/CreateInfiniteQueryOptions.md
  • docs/framework/angular/reference/interfaces/CreateMutationOptions.md
  • docs/framework/angular/reference/type-aliases/CreateBaseMutationResult.md
  • docs/framework/angular/reference/type-aliases/CreateBaseQueryResult.md
  • docs/framework/angular/reference/type-aliases/CreateInfiniteQueryResult.md
  • docs/framework/angular/reference/type-aliases/CreateMutateAsyncFunction.md
  • docs/framework/angular/reference/type-aliases/CreateMutateFunction.md
  • docs/framework/angular/reference/type-aliases/CreateMutationResult.md
  • docs/framework/angular/reference/type-aliases/CreateQueryResult.md
  • docs/framework/angular/reference/type-aliases/DefinedCreateInfiniteQueryResult.md
  • docs/framework/angular/reference/type-aliases/DefinedCreateQueryResult.md
  • docs/framework/lit/reference/functions/createInfiniteQueryController.md
  • docs/framework/lit/reference/functions/createQueriesController.md
  • docs/framework/lit/reference/functions/createQueryController.md
  • docs/framework/lit/reference/functions/useMutationState.md
  • docs/framework/lit/reference/type-aliases/CreateInfiniteQueryOptions.md
  • docs/framework/lit/reference/type-aliases/CreateQueriesControllerOptions.md
  • docs/framework/lit/reference/type-aliases/CreateQueriesInput.md
  • docs/framework/lit/reference/type-aliases/CreateQueryOptions.md
  • docs/framework/lit/reference/type-aliases/InfiniteQueryResultAccessor.md
  • docs/framework/lit/reference/type-aliases/MutationStateAccessor.md
  • docs/framework/lit/reference/type-aliases/MutationStateOptions.md
  • docs/framework/lit/reference/type-aliases/QueriesResultAccessor.md
  • docs/framework/lit/reference/type-aliases/QueryResultAccessor.md
  • docs/framework/preact/reference/functions/HydrationBoundary.md
  • docs/framework/preact/reference/functions/QueryClientProvider.md
  • docs/framework/preact/reference/functions/QueryErrorResetBoundary.md
  • docs/framework/preact/reference/functions/infiniteQueryOptions.md
  • docs/framework/preact/reference/functions/mutationOptions.md
  • docs/framework/preact/reference/functions/queryOptions.md
  • docs/framework/preact/reference/functions/useInfiniteQuery.md
  • docs/framework/preact/reference/functions/useIsFetching.md
  • docs/framework/preact/reference/functions/useIsMutating.md
  • docs/framework/preact/reference/functions/useIsRestoring.md
  • docs/framework/preact/reference/functions/useMutation.md
  • docs/framework/preact/reference/functions/useMutationState.md
  • docs/framework/preact/reference/functions/usePrefetchInfiniteQuery.md
  • docs/framework/preact/reference/functions/usePrefetchQuery.md
  • docs/framework/preact/reference/functions/useQueries.md
  • docs/framework/preact/reference/functions/useQuery.md
  • docs/framework/preact/reference/functions/useQueryClient.md
  • docs/framework/preact/reference/functions/useQueryErrorResetBoundary.md
  • docs/framework/preact/reference/functions/useSuspenseInfiniteQuery.md
  • docs/framework/preact/reference/functions/useSuspenseQueries.md
  • docs/framework/preact/reference/functions/useSuspenseQuery.md
  • docs/framework/preact/reference/interfaces/HydrationBoundaryProps.md
  • docs/framework/preact/reference/interfaces/QueryErrorResetBoundaryProps.md
  • docs/framework/preact/reference/interfaces/UseBaseQueryOptions.md
  • docs/framework/preact/reference/interfaces/UseInfiniteQueryOptions.md
  • docs/framework/preact/reference/interfaces/UseMutationOptions.md
  • docs/framework/preact/reference/interfaces/UsePrefetchQueryOptions.md
  • docs/framework/preact/reference/interfaces/UseQueryOptions.md
  • docs/framework/preact/reference/interfaces/UseSuspenseInfiniteQueryOptions.md
  • docs/framework/preact/reference/interfaces/UseSuspenseQueryOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseBaseQueryOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseInfiniteQueryOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseMutationOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseQueryOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseSuspenseInfiniteQueryOptions.md
  • docs/framework/preact/reference/type-aliases/AnyUseSuspenseQueryOptions.md
  • docs/framework/preact/reference/type-aliases/DefinedInitialDataInfiniteOptions.md
  • docs/framework/preact/reference/type-aliases/DefinedInitialDataOptions.md
  • docs/framework/preact/reference/type-aliases/DefinedUseInfiniteQueryResult.md
  • docs/framework/preact/reference/type-aliases/DefinedUseQueryResult.md
  • docs/framework/preact/reference/type-aliases/QueriesOptions.md
  • docs/framework/preact/reference/type-aliases/QueriesResults.md
  • docs/framework/preact/reference/type-aliases/QueryClientProviderProps.md
  • docs/framework/preact/reference/type-aliases/QueryErrorClearResetFunction.md
  • docs/framework/preact/reference/type-aliases/QueryErrorIsResetFunction.md
  • docs/framework/preact/reference/type-aliases/QueryErrorResetBoundaryFunction.md
  • docs/framework/preact/reference/type-aliases/QueryErrorResetFunction.md
  • docs/framework/preact/reference/type-aliases/SuspenseQueriesOptions.md
  • docs/framework/preact/reference/type-aliases/SuspenseQueriesResults.md
  • docs/framework/preact/reference/type-aliases/UndefinedInitialDataInfiniteOptions.md
  • docs/framework/preact/reference/type-aliases/UndefinedInitialDataOptions.md
  • docs/framework/preact/reference/type-aliases/UnusedSkipTokenInfiniteOptions.md
  • docs/framework/preact/reference/type-aliases/UnusedSkipTokenOptions.md
  • docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md
  • docs/framework/preact/reference/type-aliases/UseBaseQueryResult.md
  • docs/framework/preact/reference/type-aliases/UseInfiniteQueryResult.md
  • docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md
  • docs/framework/preact/reference/type-aliases/UseMutateFunction.md
  • docs/framework/preact/reference/type-aliases/UseMutationResult.md
  • docs/framework/preact/reference/type-aliases/UseQueryResult.md
  • docs/framework/preact/reference/type-aliases/UseSuspenseInfiniteQueryResult.md
  • docs/framework/preact/reference/type-aliases/UseSuspenseQueryResult.md
  • docs/framework/preact/reference/variables/IsRestoringProvider.md
  • docs/framework/preact/reference/variables/QueryClientContext.md
  • docs/framework/svelte/reference/functions/mutationOptions.md
  • docs/framework/svelte/reference/index.md
  • docs/framework/svelte/reference/type-aliases/HydrationBoundary.md
  • docs/framework/svelte/reference/variables/HydrationBoundary.md

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


📝 Walkthrough

Walkthrough

Updated Angular, Lit, Preact, and Svelte reference documentation. Changes revise wording, synchronize source links and line numbers, correct the Preact HydrationBoundary return type, and add mutationOptions to the Svelte index.

Changes

Framework reference documentation

Layer / File(s) Summary
Angular reference updates
docs/framework/angular/reference/...
Revised descriptions and updated documented types.ts source locations.
Lit reference updates
docs/framework/lit/reference/...
Updated controller, option, accessor, and mutation-state source links.
Preact reference updates
docs/framework/preact/reference/...
Moved source links to the TanStack Query repository, adjusted line numbers, and changed HydrationBoundary to return Element.
Svelte reference updates
docs/framework/svelte/reference/...
Added mutationOptions, updated generated formatting, and refreshed Svelte type-definition references.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 28091

This change updates generated reference documentation and source links without changing published runtime behavior; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly summarizes the documentation regeneration and the main stale-content and Preact-link fixes.
Description check ✅ Passed The description explains the changes and motivation, completes the checklist, and identifies the docs-only release impact.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-preact-source-links

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.

@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@11189

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 28091f2

@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

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

@sukvvon
sukvvon merged commit a9f416b into main Aug 16, 2026
9 checks passed
@sukvvon
sukvvon deleted the docs/fix-preact-source-links branch August 16, 2026 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant