Skip to content

Conversation

@sanny-io
Copy link
Contributor

@sanny-io sanny-io commented Jan 7, 2026

Summary by CodeRabbit

  • Documentation
    • Updated CUID function documentation with a deprecation notice for CUID v1, recommending users migrate to CUID v2.

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

@vercel
Copy link

vercel bot commented Jan 7, 2026

@sanny-io is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2026

Walkthrough

Documentation update to the cuid() function in the reference guide adding a deprecation notice recommending migration from CUID v1 to v2, with an accompanying HTML line break for formatting.

Changes

Cohort / File(s) Summary
Documentation Updates
docs/reference/zmodel/function.md
Added deprecation note after version parameter indicating CUID v1 is deprecated and recommending use of v2

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • doc: v2.11.1 release #421: Also updates cuid() documentation with CUID v2 guidance and introduces related function signature changes and ulid() documentation.
🚥 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: note cuid1 deprecation' directly and clearly summarizes the main change—adding a deprecation note for CUID v1 in documentation.
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.


📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2475ef and 8c53257.

📒 Files selected for processing (1)
  • docs/reference/zmodel/function.md
🔇 Additional comments (1)
docs/reference/zmodel/function.md (1)

112-113: Good deprecation notice for CUID v1.

The addition clearly communicates the deprecation and provides actionable guidance for users to migrate to v2. The formatting and placement within the parameter documentation is appropriate.


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.

@ymc9
Copy link
Member

ymc9 commented Jan 9, 2026

Thanks @sanny-io . I'm merging it.

@ymc9 ymc9 merged commit 1d6b144 into zenstackhq:main Jan 9, 2026
2 of 3 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