doc: update orm package name

[ymc9]

Summary by CodeRabbit

• Documentation
  • Updated version 3.x documentation across migration guides, API references, and plugin documentation to reflect that ZenStack client imports and type definitions are now sourced from the ORM package. Updated code examples and dependency installation instructions to guide developers on correct package imports and setup procedures.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
zenstack-new-site	Ready	Preview	Comment	Nov 1, 2025 1:35am

[coderabbitai]

Walkthrough

Documentation updates reflecting a package migration from @zenstackhq/runtime to @zenstackhq/orm across multiple ORM-related documentation files, including import examples, dependency declarations, and module references in version 3.x documentation.

Changes

Cohort / File(s)	Change Summary
Package dependency and import updates versioned_docs/version-3.x/migrate-prisma.md, versioned_docs/version-3.x/orm/quick-start.md	Updated package dependency from @zenstackhq/runtime to @zenstackhq/orm in installation and setup sections.
ZenStackClient import path updates versioned_docs/version-3.x/orm/access-control/query.md, versioned_docs/version-3.x/orm/client.md, versioned_docs/version-3.x/reference/plugins/policy.md	Changed ZenStackClient import source from @zenstackhq/runtime to @zenstackhq/orm in code examples.
Type import path updates versioned_docs/version-3.x/orm/client.md	Updated ClientContract type import from @zenstackhq/runtime to @zenstackhq/orm.
Module reference updates versioned_docs/version-3.x/orm/errors.md, versioned_docs/version-3.x/orm/inferred-types.md, versioned_docs/version-3.x/reference/api.md, versioned_docs/version-3.x/reference/zmodel/attribute.md	Updated referenced module and import paths from @zenstackhq/runtime to @zenstackhq/orm in error, type, and metadata documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• All changes are documentation-only with highly homogeneous patterns (consistent package reference updates)
• No functional logic, behavior changes, or complex reasoning required per file
• Large scope (9 files) is offset by repetitive nature of edits (same refactoring applied uniformly)

Possibly related PRs

• zenstack-docs#495: Updates documentation referencing the same public symbols (ZenStackClient) and package import paths in version-3.x docs.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

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.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "doc: update orm package name" is directly related to the changeset. All nine modified files are documentation files that systematically update import paths and package references from @zenstackhq/runtime to @zenstackhq/orm across multiple sections (migration guides, ORM documentation, API references, and zmodel attributes). The title clearly identifies that this is a documentation change focused on updating the ORM package references, which accurately captures the main objective of the PR. The use of the "doc:" prefix follows conventional commit message formatting and effectively conveys that this is a documentation-only change.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/qaas-v3

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 685bab3 and d3c7551.

📒 Files selected for processing (9)

• versioned_docs/version-3.x/migrate-prisma.md (3 hunks)
• versioned_docs/version-3.x/orm/access-control/query.md (1 hunks)
• versioned_docs/version-3.x/orm/client.md (3 hunks)
• versioned_docs/version-3.x/orm/errors.md (1 hunks)
• versioned_docs/version-3.x/orm/inferred-types.md (1 hunks)
• versioned_docs/version-3.x/orm/quick-start.md (1 hunks)
• versioned_docs/version-3.x/reference/api.md (1 hunks)
• versioned_docs/version-3.x/reference/plugins/policy.md (1 hunks)
• versioned_docs/version-3.x/reference/zmodel/attribute.md (2 hunks)

🔇 Additional comments (9)

versioned_docs/version-3.x/orm/inferred-types.md (1)

22-22: Approve package reference update.

The ModelResult import path is correctly updated to reflect the new package organization.

versioned_docs/version-3.x/orm/quick-start.md (1)

49-49: Approve dependency update.

The manual setup dependency correctly references the new @zenstackhq/orm@next package.

versioned_docs/version-3.x/reference/zmodel/attribute.md (1)

368-368: Approve model-meta import path updates.

Both model-level and field-level @meta attribute documentation correctly reference the new @zenstackhq/orm/model-meta package path.

Also applies to: 485-485

versioned_docs/version-3.x/reference/api.md (1)

9-9: Approve API reference header update.

The API reference section correctly identifies the package as @zenstackhq/orm.

versioned_docs/version-3.x/orm/errors.md (1)

8-8: Approve error module reference update.

The error classes documentation correctly references the new @zenstackhq/orm package.

versioned_docs/version-3.x/migrate-prisma.md (1)

35-35: Approve migration guide package updates.

All three package references are correctly updated: the main dependency (line 35) and both database-specific import examples (PostgreSQL and SQLite tabs at lines 90 and 108).

Also applies to: 90-90, 108-108

versioned_docs/version-3.x/reference/plugins/policy.md (1)

149-149: Approve runtime plugin example update.

The policy plugin usage example correctly imports ZenStackClient from @zenstackhq/orm.

versioned_docs/version-3.x/orm/client.md (1)

28-28: Approve database client documentation updates.

All package references are correctly updated across both database examples (SQLite and PostgreSQL) and the type import example. The ZenStackClient and ClientContract imports now reference @zenstackhq/orm.

Also applies to: 46-46, 66-66

versioned_docs/version-3.x/orm/access-control/query.md (1)

16-16: Import path update is correct and consistently applied.

The change updating ZenStackClient import from @zenstackhq/runtime to @zenstackhq/orm has been verified as complete and consistent across all related documentation files. No remaining references to the old package name were found in the ORM documentation, migration guide, or reference sections.

---

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