doc: v3.2.0 release

[ymc9]

Summary by CodeRabbit

• New Features

  • Added watch flag (-w, --watch) to CLI for automatic code regeneration on file changes.

• Documentation

  • Documented exists API for efficient record existence checks.
  • Added integration guide for tRPC (community-maintained).
  • Updated documentation with proper attributions.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

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

Project	Deployment	Review	Updated (UTC)
zenstack-new-site	Ready	Preview, Comment	Jan 9, 2026 8:37am

[coderabbitai]

Warning

Rate limit exceeded

@ymc9 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 39 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between dd8a938 and b67f9a8.

📒 Files selected for processing (1)

• docs/orm/api/find.md

Walkthrough

This PR adds documentation content and updates configuration. It includes attribution blocks for custom procedures, new API documentation for the exists function, tRPC integration recipe documentation, CLI watch flag documentation, and updates the footer social share image configuration.

Changes

Cohort / File(s)	Summary
Custom Procedures Documentation docs/modeling/custom-proc.md, docs/orm/custom-proc.md	Added blockquote attribution crediting Mike Willbanks with GitHub profile link under Custom Procedure/Procedures headers.
ORM API Documentation docs/orm/api/find.md	Added new exists API documentation section describing record existence checking with performance notes.
Recipe Documentation docs/recipe/trpc.md	New documentation file for tRPC integration, noting community maintenance and crediting Olup for implementation.
CLI Reference docs/reference/cli.md	Added watch flag (-w, --watch) documentation for global CLI options and zen generate command.
Configuration docusaurus.config.js	Updated footer social share image path from seasonal xmas variant to standard social-cover.png.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• zenstackhq/zenstack-docs#534 — Modifies the same docusaurus.config.js footer social share image configuration
• zenstackhq/zenstack-docs#548 — Updates the same custom procedure documentation files with broader content changes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'doc: v3.2.0 release' directly corresponds to the pull request's content, which documents the v3.2.0 release with multiple documentation updates including new features (exists API, watch flag), community integrations (tRPC), and attribution credits.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/orm/custom-proc.md (1)

11-12: Use formal language in the attribution.

The word "amazing" is too colloquial for technical documentation. Consider using a more formal alternative like "powerful", "elegant", or "valuable".

✏️ Suggested language improvement

-> This amazing feature is implemented by [Mike Willbanks
+> This powerful feature is implemented by [Mike Willbanks

docs/modeling/custom-proc.md (1)

12-13: Use formal language in the attribution.

The word "amazing" is too colloquial for technical documentation. Consider using a more formal alternative like "powerful", "elegant", or "valuable". This same improvement should be applied to the parallel attribution in docs/orm/custom-proc.md.

✏️ Suggested language improvement

-> This amazing feature is implemented by [Mike Willbanks
+> This powerful feature is implemented by [Mike Willbanks

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a266fdd and dd8a938.

📒 Files selected for processing (6)

• docs/modeling/custom-proc.md
• docs/orm/api/find.md
• docs/orm/custom-proc.md
• docs/recipe/trpc.md
• docs/reference/cli.md
• docusaurus.config.js

🧰 Additional context used

🪛 LanguageTool

docs/modeling/custom-proc.md

[style] ~12-~12: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...ableSince'; # Custom Procedure > This amazing feature is implemented by [Mike Willban...

(AWESOME)

docs/recipe/trpc.md

[style] ~9-~9: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...olup) for building and maintaining this amazing implementation!

(AWESOME)

docs/orm/custom-proc.md

[style] ~11-~11: Consider using a more formal and expressive alternative to ‘amazing’.
Context: ...bleSince'; # Custom Procedures > This amazing feature is implemented by [Mike Willban...

(AWESOME)

🔇 Additional comments (4)

docs/orm/api/find.md (1)

33-35: LGTM!

Clear and concise documentation for the new exists() API method. The performance note appropriately highlights its advantage over alternative approaches.

docusaurus.config.js (1)

224-224: LGTM! Social cover image updated appropriately.

The change from the holiday-themed social cover to the standard version is appropriate post-holiday season.

docs/reference/cli.md (1)

48-48: LGTM! Watch flag documentation is clear and well-formatted.

The documentation for the new watch flag follows the established format and clearly describes its functionality.

docs/recipe/trpc.md (1)

1-9: LGTM! Clear documentation for the tRPC integration transition.

The documentation effectively communicates the shift to community maintenance and appropriately credits the maintainer. The tone is well-suited for community acknowledgments in open-source documentation.