chore: misc updates

[ymc9]

Summary by CodeRabbit

• Documentation
  • Updated CLI description to present a more modern positioning.
  • Standardized docs links to use the non-versioned/latest docs URL.
  • Replaced "next" package usage examples with "latest" and updated install/init command examples.
  • Updated migration reference link to the non-versioned docs path.
  • Clarified policy check documentation to note delegation to to-one relations and which relation field is referenced.

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

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

📝 Walkthrough

Walkthrough

This PR updates CLI help text and documentation URLs, standardizes README documentation links and package references, and clarifies policy plugin documentation to state delegation supports only to-one relations and that the field parameter refers to the relation field.

Changes

Cohort / File(s)	Summary
CLI description and docs URL packages/cli/src/index.ts	Reworded CLI description ("is the data layer" → "is the modern data layer") and replaced versioned docs URL https://zenstack.dev/docs/3.x with https://zenstack.dev/docs.
Policy plugin documentation packages/plugins/policy/plugin.zmodel	Updated access policy check documentation to indicate delegation targets to-one relations and that the field parameter refers to the relation field to delegate to.
Repository README and install snippets README.md	Standardized docs links to non-versioned /docs/, replaced @next references with @latest or unversioned package commands across examples and migration references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• chore: import CLI help text #411 — Modifies CLI help/description text in packages/cli/src/index.ts, overlapping CLI wording and docs URL changes.
• feat: CLI telemetry #220 — Changes createProgram in packages/cli/src/index.ts, including CLI signature and telemetry wrapping; directly touches the same CLI entry point.
• chore: update readme #216 — Revises README and documentation links; related to the README changes here.

Poem

🐇 I hopped through lines of text tonight,

Tweaked URLs to make them bright,
Reworded help with careful art,
Told plugins which relations start,
A tiny hop — a clearer chart. 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Title check	❓ Inconclusive	The title 'chore: misc updates' is vague and generic, using non-descriptive language that fails to convey the specific changes made in the pull request.	Replace with a more specific title that describes the main changes, such as 'chore: update documentation URLs and package references to latest versions' or 'chore: standardize docs links and update CLI description'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/misc-7

---

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

[claude]

Claude finished @ymc9's task —— View job

---

Pull Request Review

Todo List:

• Examine changed files to understand modifications
• Analyze code quality and best practices
• Check for potential bugs or issues
• Review performance considerations
• Assess security concerns
• Evaluate test coverage impact
• Provide comprehensive feedback

Changes Summary:
This PR contains minor but well-executed maintenance updates:

1. CLI description improvement (packages/cli/src/index.ts:53): "the data layer for modern TypeScript apps" → "the modern data layer for TypeScript apps"
2. Documentation URL simplification (packages/cli/src/index.ts:53): https://zenstack.dev/docs/3.x → https://zenstack.dev/docs
3. Function documentation enhancement (packages/plugins/policy/plugin.zmodel:36-38): Clarified check() function purpose and parameters

Review Feedback

✅ Code Quality & Best Practices

• Excellent: All changes maintain existing code style and conventions
• Good: The wording improvement makes the CLI description more natural
• Positive: Documentation simplification removes version-specific URL, making it more maintainable

✅ Potential Bugs or Issues

• No concerns: Changes are purely textual/documentation
• Safe: No functional code modifications that could introduce bugs
• Low risk: URL change should redirect appropriately on the documentation site

✅ Performance Considerations

• No impact: These are string literals loaded at CLI startup
• Negligible: Documentation comments have zero runtime impact

✅ Security Concerns

• No security implications: All changes are text/documentation only
• Safe: URL change uses same trusted domain

✅ Test Coverage

• Not applicable: Changes don't affect testable functionality
• Consideration: CLI help text could theoretically be tested, but these changes are low-risk

Recommendation

✅ Approve - This is a clean maintenance PR that improves user-facing text and documentation clarity without any functional risks.

---

[Copilot]

Pull request overview

This PR contains miscellaneous documentation and text updates:

• Updates the check function documentation in the policy plugin to more accurately describe its purpose (delegating access control to relations)
• Refines the CLI description text to align with other project messaging
• Updates the documentation URL format

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
packages/plugins/policy/plugin.zmodel	Improves accuracy of the check function documentation to clarify it delegates access control to relations and only supports to-one relations
packages/cli/src/index.ts	Updates the CLI description text from "data layer for modern TypeScript" to "modern data layer for TypeScript" and changes documentation URL from versioned to non-versioned format

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[claude]

Claude finished @ymc9's task —— View job

---

Pull Request Review

Todo List:

• Examine changed files to understand modifications
• Analyze code quality and best practices
• Check for potential bugs or issues
• Review performance considerations
• Assess security concerns
• Evaluate test coverage impact
• Provide comprehensive feedback

Changes Summary:
This PR contains minor but well-executed maintenance updates:

1. CLI description improvement (packages/cli/src/index.ts:53): "the data layer for modern TypeScript apps" → "the modern data layer for TypeScript apps"
2. Documentation URL simplification (packages/cli/src/index.ts:53): https://zenstack.dev/docs/3.x → https://zenstack.dev/docs
3. Function documentation enhancement (packages/plugins/policy/plugin.zmodel:36-38): Clarified check() function purpose and parameters

Review Feedback

✅ Code Quality & Best Practices

• Excellent: All changes maintain existing code style and conventions
• Good: The wording improvement makes the CLI description more natural
• Positive: Documentation simplification removes version-specific URL, making it more maintainable

✅ Potential Bugs or Issues

• No concerns: Changes are purely textual/documentation
• Safe: No functional code modifications that could introduce bugs
• Low risk: URL change should redirect appropriately on the documentation site

✅ Performance Considerations

• No impact: These are string literals loaded at CLI startup
• Negligible: Documentation comments have zero runtime impact

✅ Security Concerns

• No security implications: All changes are text/documentation only
• Safe: URL change uses same trusted domain

✅ Test Coverage

• Not applicable: Changes don't affect testable functionality
• Consideration: CLI help text could theoretically be tested, but these changes are low-risk

Recommendation

✅ Approve - This is a clean maintenance PR that improves user-facing text and documentation clarity without any functional risks.

---

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b49822 and 0059b76.

📒 Files selected for processing (1)

• README.md

🧰 Additional context used

🧠 Learnings (7)

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to **/*.zmodel : ZModel schema files should define database structure and policies that compile to TypeScript via `zenstack generate`

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/orm/**/*.{ts,tsx} : Use Kysely as the query builder interface for low-level database queries, avoiding raw SQL when possible

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Database migrations should use Prisma CLI under the hood via ZenStack commands

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/orm/**/*.{ts,tsx} : Implement plugin hooks at ORM, Kysely, and entity mutation levels for query interception and customization

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/orm/**/*.test.{ts,tsx} : ORM package tests should include comprehensive client API tests and policy tests

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to **/*.zmodel : Always run `zenstack generate` after modifying ZModel schemas

Applied to files:

• README.md

📚 Learning: 2025-11-26T01:55:04.540Z

Learnt from: CR
Repo: zenstackhq/zenstack-v3 PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-26T01:55:04.540Z
Learning: Applies to packages/zenstackhq/cli/**/*.test.{ts,tsx} : CLI package tests should focus on action-specific tests for each command

Applied to files:

• README.md

🪛 markdownlint-cli2 (0.18.1)

README.md

28-28: Bare URL used

(MD034, no-bare-urls)

⏰ 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). (2)

• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: build-test (20.x, postgresql)

🔇 Additional comments (1)

README.md (1)

52-52: Documentation and package version standardization looks good.

The changes standardize package references (removing @next in favor of @latest or stable versions) and update documentation URLs to non-versioned paths (/docs/ instead of /docs/3.x/), which aligns well with the PR objectives.

Also applies to: 66-66, 74-74, 82-83, 90-90

[claude]

Claude finished @ymc9's task —— View job

---

Pull Request Review

Todo List:

• Examine changed files to understand modifications
• Analyze code quality and best practices
• Check for potential bugs or issues
• Review performance considerations
• Assess security concerns
• Evaluate test coverage impact
• Provide comprehensive feedback

Changes Summary:
This PR contains minor but well-executed maintenance updates:

1. CLI description improvement (packages/cli/src/index.ts:53): "the data layer for modern TypeScript apps" → "the modern data layer for TypeScript apps"
2. Documentation URL simplification (packages/cli/src/index.ts:53): https://zenstack.dev/docs/3.x → https://zenstack.dev/docs
3. Function documentation enhancement (packages/plugins/policy/plugin.zmodel:36-38): Clarified check() function purpose and parameters

Review Feedback

✅ Code Quality & Best Practices

• Excellent: All changes maintain existing code style and conventions
• Good: The wording improvement makes the CLI description more natural
• Positive: Documentation simplification removes version-specific URL, making it more maintainable

✅ Potential Bugs or Issues

• No concerns: Changes are purely textual/documentation
• Safe: No functional code modifications that could introduce bugs
• Low risk: URL change should redirect appropriately on the documentation site

✅ Performance Considerations

• No impact: These are string literals loaded at CLI startup
• Negligible: Documentation comments have zero runtime impact

✅ Security Concerns

• No security implications: All changes are text/documentation only
• Safe: URL change uses same trusted domain

✅ Test Coverage

• Not applicable: Changes don't affect testable functionality
• Consideration: CLI help text could theoretically be tested, but these changes are low-risk

Recommendation

✅ Approve - This is a clean maintenance PR that improves user-facing text and documentation clarity without any functional risks.