Skip to content

Comments

chore(preact-query): Preact docs match fix#10171

Merged
theVedanta merged 2 commits intoTanStack:mainfrom
theVedanta:preact-docs-match-fix
Feb 22, 2026
Merged

chore(preact-query): Preact docs match fix#10171
theVedanta merged 2 commits intoTanStack:mainfrom
theVedanta:preact-docs-match-fix

Conversation

@theVedanta
Copy link
Contributor

@theVedanta theVedanta commented Feb 22, 2026

🎯 Changes

✅ 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
    • Updated Preact framework documentation metadata and reference paths for consistency across all guides.

@changeset-bot
Copy link

changeset-bot bot commented Feb 22, 2026

⚠️ No Changeset found

Latest commit: 20887fb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 22, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 22, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

Systematically updates Preact framework documentation by reordering replacement mappings in front matter, adding .md file extensions to reference paths, and removing or modifying specific replacement rules across 36 guide files.

Changes

Cohort / File(s) Summary
Replace mapping reordering only
docs/framework/preact/graphql.md, docs/framework/preact/guides/background-fetching-indicators.md, docs/framework/preact/guides/caching.md, docs/framework/preact/guides/default-query-function.md, docs/framework/preact/guides/dependent-queries.md, docs/framework/preact/guides/disabling-queries.md, docs/framework/preact/installation.md, docs/framework/preact/overview.md, docs/framework/preact/plugins/persistQueryClient.md, docs/framework/preact/quick-start.md, docs/framework/preact/typescript.md
Reordered replace mapping keys from { 'React': 'Preact', 'react-query': 'preact-query' } to { 'react-query': 'preact-query', 'React': 'Preact' }; functionally equivalent with no behavioral changes.
Ref path extension & replace mapping reordering
docs/framework/preact/guides/does-this-replace-client-state.md, docs/framework/preact/guides/filters.md, docs/framework/preact/guides/important-defaults.md, docs/framework/preact/guides/infinite-queries.md, docs/framework/preact/guides/initial-query-data.md, docs/framework/preact/guides/invalidations-from-mutations.md, docs/framework/preact/guides/mutations.md, docs/framework/preact/guides/network-mode.md, docs/framework/preact/guides/optimistic-updates.md, docs/framework/preact/guides/paginated-queries.md, docs/framework/preact/guides/parallel-queries.md, docs/framework/preact/guides/placeholder-query-data.md, docs/framework/preact/guides/prefetching.md, docs/framework/preact/guides/queries.md, docs/framework/preact/guides/query-cancellation.md, docs/framework/preact/guides/query-functions.md, docs/framework/preact/guides/query-invalidation.md, docs/framework/preact/guides/query-keys.md, docs/framework/preact/guides/query-options.md, docs/framework/preact/guides/query-retries.md, docs/framework/preact/guides/render-optimizations.md, docs/framework/preact/guides/request-waterfalls.md
Added .md file extension to ref paths and reordered replace mapping keys to match standardized format.
Replace mapping modifications
docs/framework/preact/guides/scroll-restoration.md, docs/framework/preact/guides/updates-from-mutation-responses.md, docs/framework/preact/guides/window-focus-refetching.md
Removed or modified replace mapping rules; scroll-restoration and updates-from-mutation-responses removed entire replace blocks, while window-focus-refetching retained only react-query replacement.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

documentation

Suggested reviewers

  • TkDodo

Poem

🐰 Keys reordered with methodical care,
Extensions added everywhere, fair and square,
Thirty-six guides now harmonized with grace,
Preact docs find their rightful place!
A tidy sweep through the doc embrace! 📚✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description follows the required template structure but the 'Changes' section is empty with only a comment placeholder, providing no meaningful detail about what was actually changed or why despite the template requirement. Add a detailed explanation in the 'Changes' section describing the documentation fixes, such as the ref path updates and replace mapping reordering across Preact guide files.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore(preact-query): Preact docs match fix' clearly indicates the PR involves fixing Preact documentation, which aligns with the changeset that primarily reorders replace mappings and fixes ref paths across 34 Preact documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

@nx-cloud
Copy link

nx-cloud bot commented Feb 22, 2026

View your CI Pipeline Execution ↗ for commit 20887fb

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

☁️ Nx Cloud last updated this comment at 2026-02-22 18:48:59 UTC

@pkg-pr-new
Copy link

pkg-pr-new bot commented Feb 22, 2026

More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/preact-query

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 20887fb

@theVedanta theVedanta merged commit 4511b63 into TanStack:main Feb 22, 2026
7 checks passed
DogPawHat pushed a commit to DogPawHat/query that referenced this pull request Feb 23, 2026
* chore(preact-query): dual-match-pattern in docs

* window-focus-native fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant