Skip to content

docs(preact-query): fix broken TkDodo link mangled by 'react-query'->'preact-query' replace - #11389

Merged
sukvvon merged 1 commit into
mainfrom
docs/preact-query-fix-testing-guide-overrides
Sep 4, 2026
Merged

docs(preact-query): fix broken TkDodo link mangled by 'react-query'->'preact-query' replace#11389
sukvvon merged 1 commit into
mainfrom
docs/preact-query-fix-testing-guide-overrides

Conversation

@sukvvon

@sukvvon sukvvon commented Sep 4, 2026

Copy link
Copy Markdown
Member

🎯 Changes

The "Further reading" link on the deployed Preact Testing guide (https://tanstack.com/query/latest/docs/framework/preact/guides/testing) is currently a 404. Verified in-browser: the rendered page links to https://tkdodo.eu/blog/testing-preact-query, which doesn't exist — the real article is https://tkdodo.eu/blog/testing-react-query.

Root cause: docs/framework/preact/guides/testing.md inherits react's docs/framework/react/guides/testing.md via ref:, and applies replace: { 'react-query': 'preact-query', 'React': 'Preact' } over the whole rendered output. The "Further reading" section wasn't wrapped in a [//]: # 'Section' override marker (added in #11377), so the react-querypreact-query substitution mangled the substring inside the article's URL slug (testing-react-querytesting-preact-query).

  • docs/framework/react/guides/testing.md: wraps the "Further reading" section in a [//]: # 'FurtherReading' marker so it can be overridden per-framework. No wording change to the React page.
  • docs/framework/preact/guides/testing.md: overrides that section — rewords the sentence to note the article was written for a different adapter, and URL-encodes the hyphen in the slug (react%2Dquery) so the react-query substring substitution can no longer match it. Verified in-browser that the encoded URL resolves correctly to the original article.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.

🚀 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
    • Added further reading for Preact testing, including guidance on applying mock service worker techniques.
    • Marked the React testing guide’s further reading section for documentation tooling.

@coderabbitai

coderabbitai Bot commented Sep 4, 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: d4d353d2-fbe3-4830-94be-b15b78d42b8b

📥 Commits

Reviewing files that changed from the base of the PR and between ec3f992 and 7221411.

📒 Files selected for processing (2)
  • docs/framework/preact/guides/testing.md
  • docs/framework/react/guides/testing.md

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The testing guides update further reading content and documentation tooling markers. The Preact guide adds an external testing article. The React guide marks its existing further reading section for tooling.

Changes

Testing Guide Documentation

Layer / File(s) Summary
Further reading and tooling markers
docs/framework/preact/guides/testing.md, docs/framework/react/guides/testing.md
The Preact guide adds a testing article with a note about applying the approach to Preact. The React guide encloses its existing further reading section with tooling markers.

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

Merge Risk: ⚪ Minimal · up to 72214

This updates testing-guide further-reading content so Preact users receive the correct external link while React wording remains unchanged. No current merge-blocking risk remains.

Suggested reviewers: s-jooyoung

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: fixing the broken Preact documentation link caused by the React-to-Preact replacement.
Description check ✅ Passed The description explains the problem, root cause, implementation, verification, checklist status, and release impact. It matches the documented changes.
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…
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
  • Commit unit tests in branch docs/preact-query-fix-testing-guide-overrides

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.

@nx-cloud

nx-cloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 7221411

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 13s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-04 06:56:00 UTC

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

🚀 Changeset Version Preview

2 package(s) bumped directly, 23 bumped as dependents.

🟨 Minor bumps

Package Version Reason
@tanstack/svelte-query 6.1.48 → 6.2.0 Changeset
@tanstack/svelte-query-devtools 6.1.48 → 6.2.0 Dependent
@tanstack/svelte-query-persist-client 6.1.48 → 6.2.0 Dependent
@tanstack/vue-query-devtools 6.1.48 → 6.2.0 Dependent

🟩 Patch bumps

Package Version Reason
@tanstack/query-core 5.102.8 → 5.102.9 Changeset
@tanstack/angular-query-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/angular-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/eslint-plugin-query 5.102.8 → 5.102.9 Dependent
@tanstack/lit-query 0.2.20 → 0.2.21 Dependent
@tanstack/preact-query 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/preact-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/query-async-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/query-broadcast-client-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/query-persist-client-core 5.102.8 → 5.102.9 Dependent
@tanstack/query-sync-storage-persister 5.102.8 → 5.102.9 Dependent
@tanstack/react-query 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-next-experimental 5.102.8 → 5.102.9 Dependent
@tanstack/react-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-devtools 5.102.8 → 5.102.9 Dependent
@tanstack/solid-query-persist-client 5.102.8 → 5.102.9 Dependent
@tanstack/vue-query 5.102.8 → 5.102.9 Dependent

@pkg-pr-new

pkg-pr-new Bot commented Sep 4, 2026

Copy link
Copy Markdown
More templates

@tanstack/angular-query-experimental

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

@tanstack/eslint-plugin-query

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

@tanstack/lit-query

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

@tanstack/preact-query

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

@tanstack/preact-query-devtools

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

@tanstack/preact-query-persist-client

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

@tanstack/query-async-storage-persister

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 7221411

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

size-limit report 📦

Path Size
react full 11.87 KB (0%)
react minimal 8.84 KB (0%)

@sukvvon
sukvvon merged commit 9ea8ea0 into main Sep 4, 2026
11 of 12 checks passed
@sukvvon
sukvvon deleted the docs/preact-query-fix-testing-guide-overrides branch September 4, 2026 07:00
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