docs(clients): add README for client packages

[ymc9]

Summary

• Add README.md for @zenstackhq/client-helpers, @zenstackhq/fetch-client, and @zenstackhq/tanstack-query so each package shows a description on npm.
• Style matches the existing package READMEs (e.g. packages/orm, packages/server).

Test plan

• Visual review of the three new README files

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for client helper libraries covering installation, configuration, and usage examples.
  • Documented fetch-based and TanStack Query client integrations with code samples and framework support details.
  • Added guidance on shared building blocks for implementing custom clients.

[claude]

Claude finished @ymc9's task —— View job

---

PR Review: Client Package README Files

Reviewing the addition of README.md files for client packages.

Todo List:

• Read the three new README.md files
• Compare with existing README patterns in the repo
• Analyze content quality and consistency
• Check for accuracy and completeness
• Provide comprehensive review feedback

---

Review Feedback

Overall, this is a well-executed PR that adds valuable documentation for the client packages. The README files follow good conventions and provide useful information for npm users. Here are my detailed findings:

✅ Strengths

1. Consistent Structure: All three READMEs follow a consistent pattern similar to existing packages (@zenstackhq/orm, @zenstackhq/server)
2. Clear Descriptions: Each package has a concise, accurate description that matches their package.json descriptions
3. Practical Examples: The fetch-client and tanstack-query READMEs include helpful code examples
4. Documentation Links: All files include proper "Learn More" sections linking to relevant documentation

📝 Observations & Minor Suggestions

@zenstackhq/client-helpers (packages/clients/client-helpers/README.md:1-4):

• ✅ Accurately describes this as shared building blocks for other clients
• ✅ Good cross-references to fetch-client and tanstack-query packages
• ⚠️ Minor: This is quite minimal compared to others, but appropriate given it's primarily internal infrastructure

@zenstackhq/fetch-client (packages/clients/fetch-client/README.md:1-33):

• ✅ Excellent code example showing both basic usage and transactions
• ✅ Clear installation instructions
• ✅ Good description highlighting it's "lightweight" and "type-safe"
• ✅ Example imports and endpoint configuration are realistic

@zenstackhq/tanstack-query (packages/clients/tanstack-query/README.md:1-42):

• ✅ Great overview of supported frameworks (React, Vue, Svelte)
• ✅ Framework-specific installation example with peer dependencies
• ✅ Practical React usage example showing hooks and mutations
• ✅ Good note about replacing peer dependencies for different frameworks

🔍 Technical Accuracy

All code examples appear technically sound:

• Import paths match the package exports in package.json
• API usage aligns with ZenStack conventions
• TanStack Query integration follows expected patterns
• Documentation URLs are correct

📊 Consistency with Existing Patterns

The READMEs successfully match the style of existing packages:

• Similar section ordering (description → installation → usage → learn more)
• Consistent formatting and markdown usage
• Appropriate level of detail for npm package pages
• Proper cross-linking between related packages

🎯 Recommendations

1. All good to go! These READMEs effectively serve their purpose of providing npm users with quick package understanding and usage examples.

2. Consider for future: The client-helpers README could potentially benefit from a small usage example, but it's fine as-is since it's primarily for internal use.

✅ Security & Best Practices

• No security concerns
• Examples follow ZenStack best practices
• No hardcoded sensitive data or problematic patterns

Summary

This is a solid documentation improvement that will enhance the npm experience for users. The READMEs are well-written, accurate, and consistent with project conventions. Ready for merge ✅

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 09c666a2-216f-4833-986b-33a099b487c7

📥 Commits

Reviewing files that changed from the base of the PR and between adb109b and cd86cdf.

📒 Files selected for processing (3)

• packages/clients/client-helpers/README.md
• packages/clients/fetch-client/README.md
• packages/clients/tanstack-query/README.md

---

📝 Walkthrough

Walkthrough

This PR adds README documentation for three ZenStack client packages. It introduces client-helpers as the shared foundation, documents fetch-client as a lightweight type-safe fetch-based client with usage examples, and provides tanstack-query documentation covering frameworks and React hook integration.

Changes

Client Packages Documentation

Layer / File(s)

Summary

Client package READMEs packages/clients/client-helpers/README.md, packages/clients/fetch-client/README.md, packages/clients/tanstack-query/README.md

Added three READMEs documenting the client packages ecosystem: client-helpers describes shared building blocks for consuming ZenStack's CRUD service; fetch-client documents a lightweight fetch-based client with installation, createClient usage, CRUD operations, and $transaction examples; tanstack-query documents the TanStack Query integration with supported frameworks, setup instructions, and React hook usage examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A docs hop, a triple beat,
Three READMEs, clean and neat,
Clients helpers, fetch, and query too,
ZenStack's toolkit, shiny new! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title clearly and concisely summarizes the main change: adding README files for client packages.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/clients-readme

---

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.}