docs(preact-query): fix broken TkDodo link mangled by 'react-query'->'preact-query' replace - #11389
Conversation
…'preact-query' replace
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe 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. ChangesTesting Guide Documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to 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: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit 7221411
☁️ Nx Cloud last updated this comment at |
🚀 Changeset Version Preview2 package(s) bumped directly, 23 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
size-limit report 📦
|
🎯 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 ishttps://tkdodo.eu/blog/testing-react-query.Root cause:
docs/framework/preact/guides/testing.mdinherits react'sdocs/framework/react/guides/testing.mdviaref:, and appliesreplace: { '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 thereact-query→preact-querysubstitution mangled the substring inside the article's URL slug (testing-react-query→testing-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 thereact-querysubstring substitution can no longer match it. Verified in-browser that the encoded URL resolves correctly to the original article.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit