chore: update readme #216
chore: update readme #216
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughREADME.md was streamlined: three feature bullets were annotated “(coming soon)”, the “Get started” heading was renamed “Quick start”, extensive in-repo documentation sections were removed, and remaining guidance now points to external docs at https://zenstack.dev/docs/3.x/ (including the database-migration anchor). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README.md file to simplify the documentation and reflect the current state of ZenStack v3 features. The main purpose is to streamline the README by removing extensive implementation details and directing users to the dedicated documentation site.
- Marks several features as "coming soon" to accurately reflect their development status
- Changes "Get started" section title to "Quick start" for better clarity
- Replaces detailed implementation documentation with a link to the official documentation site
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Claude finished @ymc9's task —— View job README Update ReviewI've completed my review of this README simplification PR. Here's my comprehensive feedback: Todo List:
Summary of ChangesThis PR significantly simplifies the README by removing 331 lines of detailed implementation documentation and making these key changes:
Review Feedback✅ Positive Changes
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
README.md (6)
32-36: “Coming soon” bullets: consider adding status links or timelineGood to set expectations. Optionally add links to tracking issues/roadmap for these three bullets to improve clarity.
Confirm these features are indeed not available in the current alpha builds.
52-52: Preserve legacy anchor for “Get started”External references might still point to
#get-started. Add a hidden anchor to avoid link rot.+<a id="get-started"></a> # Quick start
85-87: Docs pointer is clear; consider adding 3–5 deep linksAdd direct links (e.g., “Install,” “Generate schema,” “Database migration,” “Kysely query builder,” “Policies”) to reduce bounce and help SEO.
I can propose specific deep links if you share the preferred doc slugs.
34-34: Hyphenation nit: “life-cycle” → “lifecycle”Minor consistency/grammar polish.
- - Designed for extensibility and flexibility: plugins, life-cycle hooks, etc. + - Designed for extensibility and flexibility: plugins, lifecycle hooks, etc.
3-6: Add alt text for logo for accessibilityInclude alt text on the img within the picture element.
- <img src="https://raw.githubusercontent.com/zenstackhq/zenstack-docs/main/static/img/logo.png" height="128"> + <img alt="ZenStack logo" src="https://raw.githubusercontent.com/zenstackhq/zenstack-docs/main/static/img/logo.png" height="128">
19-21: License badge points to different repoLink targets the main repo’s LICENSE. Verify this is intentional for V3; otherwise point to this repo’s LICENSE.
I can update the link once you confirm the desired target.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🧠 Learnings (4)
📚 Learning: 2025-08-04T08:43:33.161Z
Learnt from: CR
PR: zenstackhq/zenstack-v3#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T08:43:33.161Z
Learning: Kysely-Based ORM: V3 uses Kysely as query builder instead of Prisma runtime dependency
Applied to files:
README.md
📚 Learning: 2025-08-04T08:43:33.161Z
Learnt from: CR
PR: zenstackhq/zenstack-v3#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T08:43:33.161Z
Learning: No runtime dependency on prisma/client
Applied to files:
README.md
📚 Learning: 2025-08-04T08:43:33.161Z
Learnt from: CR
PR: zenstackhq/zenstack-v3#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T08:43:33.161Z
Learning: `zenstack generate` compiles ZModel to TypeScript schema (`schema.ts`)
Applied to files:
README.md
📚 Learning: 2025-08-04T08:43:33.161Z
Learnt from: CR
PR: zenstackhq/zenstack-v3#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-04T08:43:33.161Z
Learning: Schema-first approach with ZModel DSL extension of Prisma schema language
Applied to files:
README.md
🪛 LanguageTool
README.md
[grammar] ~34-~34: There might be a mistake here.
Context: ...ibility: plugins, life-cycle hooks, etc. - Automatic CRUD web APIs with adapters fo...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...ers for popular frameworks (coming soon) - Automatic [TanStack Query](https://githu...
(QB_NEW_EN)
⏰ 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). (1)
- GitHub Check: build-test (20.x)
|
Claude finished @ymc9's task —— View job README Update ReviewI've completed my review of this README simplification PR. Here's my comprehensive feedback: Todo List:
Summary of ChangesThis PR significantly simplifies the README by removing 331 lines of detailed implementation documentation and making these key changes:
Review Feedback✅ Positive Changes
|
Summary by CodeRabbit