doc: v3 tanstack-query docs

[ymc9]

Summary by CodeRabbit

• New Features

  • Added TSX syntax highlighting support in code blocks
  • Introduced --lite and --lite-only CLI options for generating lite schemas without attributes
  • Added TanStack Query client SDK integration with automatic optimistic updates and query invalidation

• Bug Fixes

  • Fixed component name typos in documentation

• Documentation

  • Comprehensive TanStack Query integration guide with setup instructions, usage examples, and advanced topics
  • Updated reference documentation

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
zenstack-new-site	Ready	Preview	Comment	Nov 5, 2025 8:47pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Updates repository submodules, adds TanStack Query client SDK documentation for version 3.x, fixes typographical errors across plugin documentation, introduces TSX syntax highlighting support, documents new CLI options, and removes placeholder documentation files.

Changes

Cohort / File(s)	Summary
Submodule Management .gitmodules, code-repos/zenstackhq/v3-doc-tanstack-query	Added new submodule entry for TanStack Query documentation and updated submodule reference to latest commit
Typo Fixes docs/reference/plugins/swr.mdx, docs/reference/plugins/tanstack-query.mdx, versioned_docs/version-1.x/reference/plugins/swr.mdx, versioned_docs/version-1.x/reference/plugins/tanstack-query.mdx	Corrected component import and usage from OptmisticLimitation to OptimisticLimitation across plugin documentation
TSX Syntax Highlighting docusaurus.config.js, src/components/GithubCodeBlock.tsx	Added TSX language support to Prism configuration and extended GithubCodeBlock component to detect and highlight .tsx files
CLI Documentation versioned_docs/version-3.x/reference/cli.md	Documented new --lite and --lite-only CLI options for schema generation
Documentation Restructuring versioned_docs/version-3.x/reference/package.md, versioned_docs/version-3.x/service/client-sdk.md	Deleted placeholder documentation files
TanStack Query Client SDK versioned_docs/version-3.x/service/client-sdk/index.md, versioned_docs/version-3.x/service/client-sdk/tanstack-query/index.md, versioned_docs/version-3.x/service/client-sdk/tanstack-query/_fine-grained-optimistic.md, versioned_docs/version-3.x/service/client-sdk/tanstack-query/_invalidation.md, versioned_docs/version-3.x/service/client-sdk/tanstack-query/_optimistic-behavior.md, versioned_docs/version-3.x/service/client-sdk/tanstack-query/_optimistic-limitation.md	Added comprehensive documentation for TanStack Query integration including setup, usage examples across React/Vue/Svelte, optimistic updates, query invalidation, and advanced features

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• TanStack Query documentation: The new comprehensive documentation page (versioned_docs/version-3.x/service/client-sdk/tanstack-query/index.md) is substantial and requires verification for accuracy, code example correctness, and alignment with actual implementation
• Consistency of typo fixes: Verify all occurrences of the misspelled component name have been corrected across versioned and current documentation
• TSX syntax highlighting integration: Confirm the ordering of file extension checks in GithubCodeBlock.tsx is correct and that .tsx detection precedes other checks appropriately

Possibly related PRs

• docs: release v2.9.0 #389: Fixes the same OptimisticLimitation typo in TanStack Query plugin documentation
• doc: notes about using context providers with RSC #408: Modifies the same TanStack Query documentation page with additional context provider and query invalidation notes
• doc: update optimistic update behavior for "upsert" #377: Adds overlapping optimistic update behavior documentation for TanStack Query

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch doc/wip-tanstack

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 38efdf7 and ac9e3a3.

⛔ Files ignored due to path filters (4)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml, !**/*.yaml
• tsconfig.json is excluded by !**/*.json
• versioned_docs/version-3.x/service/client-sdk/_category_.yml is excluded by !**/*.yml
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/_category_.yml is excluded by !**/*.yml

📒 Files selected for processing (17)

• .gitmodules (1 hunks)
• code-repos/zenstackhq/v3-doc-tanstack-query (1 hunks)
• docs/reference/plugins/swr.mdx (2 hunks)
• docs/reference/plugins/tanstack-query.mdx (2 hunks)
• docusaurus.config.js (1 hunks)
• src/components/GithubCodeBlock.tsx (1 hunks)
• versioned_docs/version-1.x/reference/plugins/swr.mdx (2 hunks)
• versioned_docs/version-1.x/reference/plugins/tanstack-query.mdx (2 hunks)
• versioned_docs/version-3.x/reference/cli.md (1 hunks)
• versioned_docs/version-3.x/reference/package.md (0 hunks)
• versioned_docs/version-3.x/service/client-sdk.md (0 hunks)
• versioned_docs/version-3.x/service/client-sdk/index.md (1 hunks)
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/_fine-grained-optimistic.md (1 hunks)
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/_invalidation.md (1 hunks)
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/_optimistic-behavior.md (1 hunks)
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/_optimistic-limitation.md (1 hunks)
• versioned_docs/version-3.x/service/client-sdk/tanstack-query/index.md (1 hunks)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}