docs: add community resources page #9831
Conversation
|
github-actions
bot
added
the
documentation
WalkthroughAdds a consolidated community-resources page, updates site navigation (new top-level Community Resources, removes Videos & Talks), deletes several framework-specific community pages and a videos page, and replaces many internal links with external TkDodo URLs; no code or public API changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 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 b62e3cc
☁️ Nx Cloud last updated this comment at |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/community-resources.md (1)
54-115: Consolidate formatting in utilities section.The utilities section contains multiple unnecessary blank lines (lines 66, 72, 78, 89) that create visual gaps between resource entries. For consistency and readability, these blank lines should be removed so all entries follow the same compact formatting.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/community-resources.md(1 hunks)docs/config.json(2 hunks)docs/framework/react/community/community-projects.md(0 hunks)docs/framework/react/community/tkdodos-blog.md(0 hunks)docs/framework/react/videos.md(0 hunks)docs/framework/solid/community/community-projects.md(0 hunks)docs/framework/solid/community/tkdodos-blog.md(0 hunks)
💤 Files with no reviewable changes (5)
- docs/framework/react/community/community-projects.md
- docs/framework/solid/community/community-projects.md
- docs/framework/react/community/tkdodos-blog.md
- docs/framework/solid/community/tkdodos-blog.md
- docs/framework/react/videos.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Test
- GitHub Check: Preview
🔇 Additional comments (3)
docs/config.json (1)
9-13: Missing navigation link for Community Resources section.The new "Community Resources" section has empty
childrenandframeworksarrays with notoproperty defined. Comparing with other sections (Getting Started, API Reference, Examples), they all specify navigation targets via thetoproperty or populate the arrays with linked content.How should this section link to
docs/community-resources.md? Either a"to": "community-resources"property is needed, or the structure should be clarified if this section uses an alternative routing convention.docs/community-resources.md (2)
1-10: Verify YAML front matter structure is compatible with the documentation system.The YAML front matter uses nested arrays of objects for each resource category (articles, media, utilities, others). Confirm that:
- The documentation parser correctly handles this structure
- The
title,url, anddescriptionfields are properly extracted- The rendering system displays these categorized resources as intended
1-193: All URLs verified as active and accessible; no duplicates found.The verification confirms that all 35 resources are properly linked:
- 34 URLs return standard success codes (200, 301, 302, 303, 307)
- 1 URL (https://connectrpc.com/docs) returns a 308 permanent redirect, which is valid
- No duplicate URLs detected across categories
The community resources page is ready for use without URL corrections needed.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/framework/react/typescript.md (1)
278-279: Optional: Consider "take a look" over "have a look" for American English consistency.Line 278 uses "have a look," which is more common in British English. In American English, "take a look" is preferred. All external URLs have been verified as accessible (HTTP 200 responses).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/community-resources.md(1 hunks)docs/framework/react/guides/query-keys.md(1 hunks)docs/framework/react/typescript.md(1 hunks)docs/framework/vue/community/community-projects.md(0 hunks)docs/framework/vue/community/tkdodos-blog.md(0 hunks)
💤 Files with no reviewable changes (2)
- docs/framework/vue/community/community-projects.md
- docs/framework/vue/community/tkdodos-blog.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/community-resources.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-19T03:18:18.303Z
Learnt from: oscartbeaumont
Repo: TanStack/query PR: 9564
File: packages/solid-query-devtools/src/production.tsx:2-3
Timestamp: 2025-08-19T03:18:18.303Z
Learning: In the solid-query-devtools package, the codebase uses a pattern of type-only default imports combined with typeof for component type annotations (e.g., `import type SolidQueryDevtoolsComp from './devtools'` followed by `typeof SolidQueryDevtoolsComp`). This pattern is consistently used across index.tsx and production.tsx files, and the maintainers prefer consistency over changing this approach.
Applied to files:
docs/framework/react/typescript.md
🪛 LanguageTool
docs/framework/react/typescript.md
[locale-violation] ~278-~278: In American English, “take a look” is more commonly used.
Context: ... tips and tricks around type inference, have a look at [React Query and TypeScript](https:/...
(HAVE_A_LOOK)
docs/framework/react/guides/query-keys.md
[locale-violation] ~100-~100: In American English, “take a look” is more commonly used.
Context: ...zing Query Keys in larger applications, have a look at [Effective React Query Keys](https:/...
(HAVE_A_LOOK)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
docs/framework/react/reference/queryOptions.md (1)
30-30: Minor: Consider "take a look" for American English consistency.Line 30 uses "have a look," which is a British English preference. For consistency with American English conventions, consider using "take a look" instead.
docs/framework/react/guides/testing.md (1)
170-170: Minor: Consider "take a look" for American English consistency.Line 170 uses "have a look," which is a British English preference. For consistency with American English conventions, consider using "take a look" instead.
docs/framework/react/guides/optimistic-updates.md (1)
194-194: Minor: Consider "take a look" for American English consistency.Line 194 uses "Have a look," which is a British English preference. For consistency with American English conventions, consider using "take a look" instead.
docs/framework/react/guides/query-keys.md (1)
100-101: Minor: Consider "take a look" for American English consistency.Line 100 uses "have a look," which is a British English preference. For consistency with American English conventions, consider using "take a look" instead.
The relative path
../../../community-resources.mdis correctly resolved (fromdocs/framework/react/guides/query-keys.mdtodocs/community-resources.md), and the link structure is sound.docs/framework/react/guides/invalidations-from-mutations.md (1)
55-55: Minor: Adjust phrasing for American English consistency.The phrase "have a look at" should be "take a look at" to align with American English conventions used throughout the documentation.
-For a technique to automatically invalidate Queries after Mutations, have a look at [TkDodo's article on Automatic Query Invalidation after Mutations](https://tkdodo.eu/blog/automatic-query-invalidation-after-mutations). +For a technique to automatically invalidate Queries after Mutations, take a look at [TkDodo's article on Automatic Query Invalidation after Mutations](https://tkdodo.eu/blog/automatic-query-invalidation-after-mutations).docs/framework/react/guides/queries.md (1)
143-143: Minor: Adjust phrasing for American English consistency.The phrase "have a look at" should be "take a look at" to align with American English conventions used throughout the documentation.
-For an alternative way of performing status checks, have a look at [this article by TkDodo](https://tkdodo.eu/blog/status-checks-in-react-query). +For an alternative way of performing status checks, take a look at [this article by TkDodo](https://tkdodo.eu/blog/status-checks-in-react-query).docs/framework/react/guides/mutations.md (1)
411-411: Minor: Adjust phrasing for American English consistency.The phrase "have a look at" should be "take a look at" to align with American English conventions used throughout the documentation.
-For more information about mutations, have a look at [TkDodo's article on Mastering Mutations in React Query](https://tkdodo.eu/blog/mastering-mutations-in-react-query). +For more information about mutations, take a look at [TkDodo's article on Mastering Mutations in React Query](https://tkdodo.eu/blog/mastering-mutations-in-react-query).docs/reference/QueryCache.md (1)
121-121: Minor: Adjust phrasing for American English consistency.The phrase "have a look at" should be "take a look at" to align with American English conventions used throughout the documentation.
-To get a better understanding how the QueryCache works internally, have a look at [the Inside React Query article by TkDodo](https://tkdodo.eu/blog/inside-react-query). +To get a better understanding how the QueryCache works internally, take a look at [the Inside React Query article by TkDodo](https://tkdodo.eu/blog/inside-react-query).docs/framework/react/guides/important-defaults.md (1)
43-43: Minor: Adjust phrasing for American English consistency.The phrase "Have a look at" should be "Take a look at" to align with American English conventions used throughout the documentation.
-Have a look at the following articles from our [Community Resources](../../../community-resources.md) for further explanations of the defaults: +Take a look at the following articles from our [Community Resources](../../../community-resources.md) for further explanations of the defaults:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
docs/framework/react/guides/advanced-ssr.md(1 hunks)docs/framework/react/guides/important-defaults.md(1 hunks)docs/framework/react/guides/infinite-queries.md(1 hunks)docs/framework/react/guides/initial-query-data.md(1 hunks)docs/framework/react/guides/invalidations-from-mutations.md(1 hunks)docs/framework/react/guides/mutations.md(1 hunks)docs/framework/react/guides/optimistic-updates.md(1 hunks)docs/framework/react/guides/placeholder-query-data.md(1 hunks)docs/framework/react/guides/prefetching.md(1 hunks)docs/framework/react/guides/queries.md(1 hunks)docs/framework/react/guides/query-keys.md(1 hunks)docs/framework/react/guides/render-optimizations.md(1 hunks)docs/framework/react/guides/testing.md(1 hunks)docs/framework/react/overview.md(1 hunks)docs/framework/react/reference/queryOptions.md(1 hunks)docs/framework/react/typescript.md(1 hunks)docs/reference/QueryCache.md(2 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/framework/react/guides/prefetching.md
- docs/framework/react/guides/infinite-queries.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/framework/react/typescript.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-11-02T22:52:33.049Z
Learnt from: DogPawHat
Repo: TanStack/query PR: 9835
File: packages/query-core/src/__tests__/queryClient.test-d.tsx:242-256
Timestamp: 2025-11-02T22:52:33.049Z
Learning: In the TanStack Query codebase, the new `query` and `infiniteQuery` methods support the `select` option for data transformation, while the legacy `fetchQuery` and `fetchInfiniteQuery` methods do not support `select` and should reject it at the type level.
Applied to files:
docs/framework/react/guides/render-optimizations.mddocs/framework/react/overview.md
🪛 LanguageTool
docs/framework/react/guides/queries.md
[locale-violation] ~143-~143: In American English, “take a look” is more commonly used.
Context: ...native way of performing status checks, have a look at [this article by TkDodo](https://tkd...
(HAVE_A_LOOK)
docs/framework/react/guides/invalidations-from-mutations.md
[locale-violation] ~55-~55: In American English, “take a look” is more commonly used.
Context: ...lly invalidate Queries after Mutations, have a look at [TkDodo's article on Automatic Query...
(HAVE_A_LOOK)
docs/reference/QueryCache.md
[locale-violation] ~121-~121: In American English, “take a look” is more commonly used.
Context: ...ng how the QueryCache works internally, have a look at [the Inside React Query article by T...
(HAVE_A_LOOK)
docs/framework/react/guides/mutations.md
[locale-violation] ~411-~411: In American English, “take a look” is more commonly used.
Context: ... For more information about mutations, have a look at [TkDodo's article on Mastering Mutat...
(HAVE_A_LOOK)
docs/framework/react/guides/query-keys.md
[locale-violation] ~100-~100: In American English, “take a look” is more commonly used.
Context: ...zing Query Keys in larger applications, have a look at [Effective React Query Keys](https:/...
(HAVE_A_LOOK)
docs/framework/react/guides/testing.md
[locale-violation] ~170-~170: In American English, “take a look” is more commonly used.
Context: ...tive setup using mock-service-worker, have a look at [this article by TkDodo on Testing R...
(HAVE_A_LOOK)
docs/framework/react/reference/queryOptions.md
[locale-violation] ~30-~30: In American English, “take a look” is more commonly used.
Context: ...ng To learn more about QueryOptions, have a look at [this article by TkDodo The Query Op...
(HAVE_A_LOOK)
🔇 Additional comments (7)
docs/framework/react/guides/placeholder-query-data.md (1)
99-99: LGTM!The external link to the TkDodo article is properly formatted and aligns with the PR's objective to consolidate community resources.
docs/framework/react/overview.md (1)
100-100: LGTM!The external link is properly formatted and aligns with the PR's objective to point to external TkDodo resources.
docs/framework/react/guides/initial-query-data.md (1)
173-173: LGTM!The external link to the TkDodo article is properly formatted and aligns with the PR's objective to consolidate community resources.
docs/framework/react/guides/advanced-ssr.md (1)
629-629: LGTM!The external link is properly formatted and aligns with the PR's objective to point to external TkDodo resources for this Advanced SSR guide.
docs/framework/react/guides/render-optimizations.md (1)
75-76: LGTM!The external TkDodo links are correctly formatted and provide direct access to the referenced resources. The phrasing flows naturally and maintains consistency with documentation standards.
docs/reference/QueryCache.md (1)
30-34: Good documentation improvement.Upgrading the method list from plain names to fully qualified identifiers (
queryCache.findvs justfind) improves clarity and makes the API more discoverable. This aligns with best practices for reference documentation.docs/framework/react/guides/important-defaults.md (1)
43-47: Good: Centralized community resources reference.The addition of the relative link to the new community resources page aligns well with the PR's objective of consolidating community resource references. The subsequent external TkDodo article links are properly formatted and provide valuable further reading.
|
@LadyBluenotes is this correct? |
|
@TkDodo I double checked and it should work now |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/framework/react/guides/query-keys.md (1)
100-101: Fix the relative path and apply American English locale preference.The shell script verification confirms two issues:
Relative path is broken: The current path
../../../../community-resources.mddoes not resolve. Fromdocs/framework/react/guides/query-keys.md, the correct relative path is../../../community-resources.md.American English locale: Change "have a look" to "take a look" to align with American English conventions.
-For tips on organizing Query Keys in larger applications, have a look at [Effective React Query Keys](https://tkdodo.eu/blog/effective-react-query-keys) and check the [Query Key Factory Package](https://github.com/lukemorales/query-key-factory) from -the [Community Resources](../../../../community-resources). +For tips on organizing Query Keys in larger applications, take a look at [Effective React Query Keys](https://tkdodo.eu/blog/effective-react-query-keys) and check the [Query Key Factory Package](https://github.com/lukemorales/query-key-factory) from +the [Community Resources](../../../community-resources).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/framework/react/guides/important-defaults.md(1 hunks)docs/framework/react/guides/query-keys.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-19T03:18:18.303Z
Learnt from: oscartbeaumont
Repo: TanStack/query PR: 9564
File: packages/solid-query-devtools/src/production.tsx:2-3
Timestamp: 2025-08-19T03:18:18.303Z
Learning: In the solid-query-devtools package, the codebase uses a pattern of type-only default imports combined with typeof for component type annotations (e.g., `import type SolidQueryDevtoolsComp from './devtools'` followed by `typeof SolidQueryDevtoolsComp`). This pattern is consistently used across index.tsx and production.tsx files, and the maintainers prefer consistency over changing this approach.
Applied to files:
docs/framework/react/guides/important-defaults.md
🪛 LanguageTool
docs/framework/react/guides/query-keys.md
[locale-violation] ~100-~100: In American English, “take a look” is more commonly used.
Context: ...zing Query Keys in larger applications, have a look at [Effective React Query Keys](https:/...
(HAVE_A_LOOK)
| Have a look at the following articles from our [Community Resources](../../../../community-resources) for further explanations of the defaults: | ||
|
|
||
| - [Practical React Query](../../community/tkdodos-blog.md#1-practical-react-query) | ||
| - [React Query as a State Manager](../../community/tkdodos-blog.md#10-react-query-as-a-state-manager) | ||
| - [Thinking in React Query](../../community/tkdodos-blog.md#21-thinking-in-react-query) | ||
| - [Practical React Query](https://tkdodo.eu/blog/practical-react-query) | ||
| - [React Query as a State Manager](https://tkdodo.eu/blog/react-query-as-a-state-manager) | ||
| - [Thinking in React Query](https://tkdodo.eu/blog/thinking-in-react-query) |
There was a problem hiding this comment.
Fix the relative path and apply locale preference for American English.
Similar to the issue in query-keys.md, two problems exist:
-
Relative path is one level too deep: The correct path from
docs/framework/react/guides/important-defaults.mdtodocs/community-resources.mdis../../../community-resources(three levels), not../../../../community-resources(four levels). -
American English locale: "Have a look" should be "take a look" in American English.
Apply this diff:
-Have a look at the following articles from our [Community Resources](../../../../community-resources) for further explanations of the defaults:
+Take a look at the following articles from our [Community Resources](../../../community-resources) for further explanations of the defaults:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Have a look at the following articles from our [Community Resources](../../../../community-resources) for further explanations of the defaults: | |
| - [Practical React Query](../../community/tkdodos-blog.md#1-practical-react-query) | |
| - [React Query as a State Manager](../../community/tkdodos-blog.md#10-react-query-as-a-state-manager) | |
| - [Thinking in React Query](../../community/tkdodos-blog.md#21-thinking-in-react-query) | |
| - [Practical React Query](https://tkdodo.eu/blog/practical-react-query) | |
| - [React Query as a State Manager](https://tkdodo.eu/blog/react-query-as-a-state-manager) | |
| - [Thinking in React Query](https://tkdodo.eu/blog/thinking-in-react-query) | |
| Take a look at the following articles from our [Community Resources](../../../community-resources) for further explanations of the defaults: | |
| - [Practical React Query](https://tkdodo.eu/blog/practical-react-query) | |
| - [React Query as a State Manager](https://tkdodo.eu/blog/react-query-as-a-state-manager) | |
| - [Thinking in React Query](https://tkdodo.eu/blog/thinking-in-react-query) |
🤖 Prompt for AI Agents
In docs/framework/react/guides/important-defaults.md around lines 43 to 47,
update the sentence and link: change the phrase "Have a look at the following
articles" to American English "Take a look at the following articles" and fix
the relative link path from "../../../../community-resources" to
"../../../community-resources" so it correctly points to
docs/community-resources.md; keep the list of article links unchanged.
2 participants
🎯 Changes
Added a community resources page to remove the section.
Added the videos / talks to the resource page and removed it from react's docs.
✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit