Skip to content

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented Aug 10, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new "Community Packages" page highlighting third-party extensions for ZenStack, including descriptions and links.
    • Updated sidebar positions for "Sample Projects" and "Upgrade" documentation pages.
    • Renamed the main heading of the "Sample Projects" page for clarity.

@vercel
Copy link

vercel bot commented Aug 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zenstack-new-site ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 10, 2025 0:09am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 10, 2025

Walkthrough

A new documentation file listing community-contributed ZenStack packages was added. Additionally, the sidebar positions for two existing documentation pages were incremented, and a heading was updated in the sample projects documentation. No changes were made to code or exported entities.

Changes

Cohort / File(s) Change Summary
Community Packages Documentation
docs/community-packages.md
Added a new documentation file introducing and listing third-party ZenStack community packages, with descriptions and links.
Sidebar Position Updates
docs/samples.md, docs/upgrade.md
Updated sidebar_position metadata in both files (incremented by one); also renamed the main heading in samples.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/community-packages

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (7)
docs/samples.md (4)

48-48: Typo: “App Route” → “App Router”

Keep terminology consistent with other entries.

- -   [Next.js (App Route) + tRPC](https://github.com/zenstackhq/sample-blog-nextjs-app-trpc)
+ -   [Next.js (App Router) + tRPC](https://github.com/zenstackhq/sample-blog-nextjs-app-trpc)

79-79: Typo: “mangement” → “management”

-    - Minimal Kanban task mangement platform
+    - Minimal Kanban task management platform

68-68: Hyphenation consistency for TanStack names

Use “TanStack Query” and “TanStack Router” (no hyphens) to match other occurrences.

-    - Frontend: React + TanStack-Query + TanStack-Router + MUI5 + Vite
+    - Frontend: React + TanStack Query + TanStack Router + MUI5 + Vite

87-87: Capitalization: “Api” → “API”

-    - Api Docs with Scalar
+    - API Docs with Scalar
docs/community-packages.md (3)

12-12: Grammar and clarity improvements

Fix “you graphql” and make the sentence complete.

-    This plugin generates a complete GraphQL schema with relations, filtering, sorting, and pagination. Saving you hours of boilerplate code to match your database models with you graphql server.
+    This plugin generates a complete GraphQL schema with relations, filtering, sorting, and pagination. It saves you hours of boilerplate by matching your database models with your GraphQL server.

16-16: Brand capitalization consistency (“ZenStack”)

Use “ZenStack” consistently.

-    Zenstack UI is a React UI library for automating form and list generation with Zenstack. It utilizes Zenstack metadata to automatically generate forms and perform required queries and mutations.
+    ZenStack UI is a React UI library for automating form and list generation with ZenStack. It utilizes ZenStack metadata to automatically generate forms and perform required queries and mutations.

6-16: Optional: add a brief community disclaimer

Helpful to set expectations about third‑party maintenance and invite contributions.

 # Community Packages

 Our wonderful community has created the following packages that extend ZenStack's functionality.
+
+:::note
+These are third‑party community packages and are maintained by their respective authors. They may evolve independently of ZenStack’s release cycle. If you find issues or have a new package to add, please open a PR to update this page.
+:::
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10b0755 and 20ad7be.

📒 Files selected for processing (3)
  • docs/community-packages.md (1 hunks)
  • docs/samples.md (1 hunks)
  • docs/upgrade.md (1 hunks)
🔇 Additional comments (3)
docs/upgrade.md (1)

6-6: Sidebar position update looks good

Position set to 9 aligns with the added Community Packages (7) and Samples (8) pages.

docs/samples.md (2)

2-2: Sidebar order adjustment approved

Setting sidebar_position to 8 correctly places this after “Community Packages” (7) and before “Upgrade” (9).


6-6: Heading simplification is fine

“Sample Projects” is concise and consistent with sidebar_label.

@ymc9 ymc9 merged commit 98b54c0 into main Aug 10, 2025
4 checks passed
@ymc9 ymc9 deleted the docs/community-packages branch August 10, 2025 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants