Skip to content

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented Dec 30, 2025

No description provided.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 30, 2025

📝 Walkthrough

Walkthrough

README.md is updated to reflect ZenStack v3's released status: npm badge URL changed from zenstack to zenstack/release-v2, "V3 is in Beta now!" section removed and replaced with "V3 is released!", and documentation links updated to point to primary site and 2.x docs.

Changes

Cohort / File(s) Change Summary
Documentation Updates
README.md
npm badge URL updated from zenstack to zenstack/release-v2; V3 beta section removed and replaced with release announcement; documentation links updated to primary site; "How it works" section link changed to blockquote-style pointing to 2.x docs

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • #2290: Introduces the "V3 is in Beta now!" section that this PR replaces with a release announcement.
  • #2289: Modifies the same V3 announcement and documentation links in README.md with similar release status updates.
  • #2326: Makes identical README changes (badge URL update, V3 status change, documentation link updates).

Pre-merge checks

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic. It uses non-descriptive terms like 'merge dev to main' that don't convey what the actual changes are, even though the README is mentioned. Replace with a more specific title that summarizes the main change, such as 'Update README to reflect V3 release' or 'Announce ZenStack V3 release and update documentation links'.
Description check ❓ Inconclusive No pull request description was provided by the author, making it impossible to assess whether the intent and context of the changes are documented. Add a pull request description that explains the purpose of the README updates, such as announcing the V3 release and clarifying the documentation structure.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

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: 1

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2bc0e5b and f0c77cf.

⛔ Files ignored due to path filters (1)
  • package.json is excluded by !**/*.json
📒 Files selected for processing (1)
  • README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

10-10: Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ 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). (4)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: build-test (20.x)
  • GitHub Check: dependency-review
🔇 Additional comments (2)
README.md (2)

27-29: Clear and accurate v3 release narrative.

The new section properly reflects v3's released status, removing beta language and clearly directing users to the separate v3 repository. The messaging is concise and actionable.


39-39: Documentation link appropriately updated.

Pointing users to the 2.x docs (the stable version) while also including the Discord link for community support is a sensible information architecture choice given the coexistence of v2 and v3. The blockquote format works well for this contextual link.

@ymc9 ymc9 merged commit 7634e2c into main Dec 30, 2025
9 checks passed
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