Skip to content

docs(preact): add missing polling guide#11004

Open
poetryofcode wants to merge 2 commits into
TanStack:mainfrom
poetryofcode:docs/preact-add-polling-guide
Open

docs(preact): add missing polling guide#11004
poetryofcode wants to merge 2 commits into
TanStack:mainfrom
poetryofcode:docs/preact-add-polling-guide

Conversation

@poetryofcode

@poetryofcode poetryofcode commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

The Preact framework was missing a polling guide that all other frameworks (React, Vue, Solid) already have.

  • Added docs/framework/preact/guides/polling.md using the ref: pattern to reuse the React polling guide with the package name substituted
  • Added the polling entry to docs/config.json in the Preact guides section (between window-focus-refetching and disabling-queries)

Changes

  • docs/framework/preact/guides/polling.md: New file referencing React polling docs
  • docs/config.json: Added polling nav entry for Preact

Test plan

  • Verify the polling guide renders correctly for Preact
  • Check that the @tanstack/preact-query package reference is correct

Summary by CodeRabbit

  • Documentation
    • Added a new Polling guide to the Preact guides navigation.
    • Updated the Preact polling guide metadata to point to the Preact-specific query package.
    • Refined a Svelte overview example to use the latest loading-state check.

poetryofcode and others added 2 commits June 26, 2026 13:07
`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.

Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The Polling guide existed for React, Vue, Solid, and Angular but was
missing from the Preact docs. Added the ref stub and wired it into
the nav config between Window Focus Refetching and Disabling Queries,
matching the ordering used by all other frameworks.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 29, 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

Run ID: 71e6b089-8939-44d1-aa1f-befffb352bc1

📥 Commits

Reviewing files that changed from the base of the PR and between d6798b5 and c205330.

📒 Files selected for processing (3)
  • docs/config.json
  • docs/framework/preact/guides/polling.md
  • docs/framework/svelte/overview.md

📝 Walkthrough

Walkthrough

Adds a "Polling" entry to the Preact guides navigation in docs/config.json and creates the corresponding polling.md frontmatter referencing @tanstack/preact-query. Also fixes the Svelte overview example to use query.isPending instead of query.isLoading.

Changes

Docs: Preact Polling Guide and Svelte Overview Fix

Layer / File(s) Summary
Preact polling guide nav and frontmatter
docs/config.json, docs/framework/preact/guides/polling.md
Adds a "Polling" navigation entry under Preact guides and sets the frontmatter replace alias to @tanstack/preact-query.
Svelte overview loading state fix
docs/framework/svelte/overview.md
Changes {#if query.isLoading} to {#if query.isPending} in the Svelte code example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • TanStack/query#10990: Applies the same query.isLoadingquery.isPending fix to docs/framework/svelte/overview.md.
  • TanStack/query#10991: Contains overlapping changes to the Preact polling guide and the Svelte overview isPending fix.

Poem

🐇 Hop hop, the polling guide is here,
Preact queries now crystal clear!
Svelte's isPending takes the stage,
Replacing isLoading on the page.
A tiny fix, a nav entry bright—
The docs bunny makes everything right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the main change: adding the missing Preact polling guide.
Description check ✅ Passed It summarizes the added Preact polling guide and nav entry, but omits the template's checklist and release-impact sections.
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 unit tests (beta)
  • Create PR with unit tests

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.

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