doc: release 3.0.0-beta.24

[ymc9]

Summary by CodeRabbit

Release Notes

• Documentation
  • Added comprehensive Better-Auth integration guide covering installation, configuration, session handling, and multi-tenant organization setup with code examples
  • Enhanced Prisma plugin documentation with improved descriptions of the output option
  • Expanded TypeScript plugin documentation with newly documented options: lite, liteOnly, and importWithFileExtension
  • Updated datasource documentation with new directUrl field and clarified required/optional field designations

[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 18, 2025 6:20am

[coderabbitai]

Walkthrough

Documentation updates across multiple files including model naming standardization (ToDo to Todo), minor wording corrections, addition of Better-Auth integration guide, reorganization of recipe documentation ordering, and expansion of plugin and datasource configuration documentation with new option descriptions.

Changes

Cohort / File(s)	Summary
Model naming standardization docs/guides/multiple-schema.md, docs/quick-start/authentication/better-auth.md, versioned_docs/version-1.x/guides/multiple-schema.md	Renamed model examples from ToDo to Todo across multiple documentation files for naming consistency
Wording corrections docs/quick-start/authentication/supabase.md	Minor phrasing improvement: "not directly to integrating authentication" → "not directly related to integrating authentication"
New Better-Auth integration guide versioned_docs/version-3.x/recipe/auth-integration/better-auth.md	Added comprehensive documentation covering Better-Auth adapter installation, ZenStack configuration as database provider, schema generation, session management, multi-tenant setup with Organization plugin, and policy integration examples
Recipe documentation reordering versioned_docs/version-3.x/recipe/postgres-multi-schema.md	Updated sidebar_position from 1 to 2 in frontmatter for documentation ordering
Prisma plugin documentation versioned_docs/version-3.x/reference/plugins/prisma.md	Reformatted and expanded output option documentation with descriptive explanation of behavior, path resolution, and defaults
TypeScript plugin documentation versioned_docs/version-3.x/reference/plugins/typescript.md	Documented four new plugin options: output, lite, liteOnly, and importWithFileExtension with descriptions of behavior and default values
Datasource configuration reference versioned_docs/version-3.x/reference/zmodel/datasource.md	Added new optional directUrl field, marked provider as Required, and clarified optional status of url, defaultSchema, and schemas fields with updated descriptions

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• The majority of changes are straightforward documentation updates with minimal cognitive load.
• Model renaming is a simple, consistent pattern applied across three files.
• New documentation additions (Better-Auth guide, plugin options, datasource fields) are informational with no code logic dependencies.
• No logic changes, control flow modifications, or potential side effects to evaluate.

Possibly related PRs

• doc: add better Auth integration #468 — Modifies docs/quick-start/authentication/better-auth.md with complementary changes to the same example file being updated in this PR.

Pre-merge checks and finishing touches

✅ 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 clearly indicates this is a documentation release for version 3.0.0-beta.24, which aligns with the multiple documentation updates across versioned and main docs folders.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch doc/beta.24

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

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

115-115: Minor wording refinement suggested for documentation clarity.

In the better-auth integration guide (file 8, line 115), consider replacing "To get it to work" with a more descriptive phrase such as "To enable this functionality" or "To use the auth context". This small improvement enhances writing quality.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 66ea0da and 1389f1a.

⛔ Files ignored due to path filters (1)

• versioned_docs/version-3.x/recipe/auth-integration/_category_.yml is excluded by !**/*.yml

📒 Files selected for processing (9)

• docs/guides/multiple-schema.md (1 hunks)
• docs/quick-start/authentication/better-auth.md (1 hunks)
• docs/quick-start/authentication/supabase.md (1 hunks)
• versioned_docs/version-1.x/guides/multiple-schema.md (1 hunks)
• versioned_docs/version-3.x/recipe/auth-integration/better-auth.md (1 hunks)
• versioned_docs/version-3.x/recipe/postgres-multi-schema.md (1 hunks)
• versioned_docs/version-3.x/reference/plugins/prisma.md (1 hunks)
• versioned_docs/version-3.x/reference/plugins/typescript.md (1 hunks)
• versioned_docs/version-3.x/reference/zmodel/datasource.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

versioned_docs/version-3.x/recipe/auth-integration/better-auth.md

[style] ~115-~115: Replace ‘get’ with a more descriptive word to set your writing apart from others.
Context: ...s via the special auth() function. To get it to work, let's add a type in ZModel to def...

(GET_STYLISH)

🔇 Additional comments (12)

versioned_docs/version-3.x/recipe/postgres-multi-schema.md (1)

2-2: Recipe ordering adjustment approved.

The sidebar_position change from 1 to 2 appears to be part of documentation reorganization. Ensure this aligns with the intended recipe ordering in the overall documentation structure.

docs/guides/multiple-schema.md (1)

35-35: Model naming standardization: ToDo → Todo.

The model name has been updated to use standard capitalization convention. This improves consistency across documentation examples.

docs/quick-start/authentication/better-auth.md (1)

113-113: Model naming standardization: ToDo → Todo.

The model name has been updated to use standard capitalization convention. This improves consistency across documentation examples and aligns with the broader documentation standardization in this PR.

docs/quick-start/authentication/supabase.md (1)

19-19: Grammatical improvement: Enhanced sentence clarity.

Line 19 has been corrected from "not directly to integrating" to "not directly related to integrating", which improves readability and grammatical correctness.

versioned_docs/version-1.x/guides/multiple-schema.md (1)

35-35: Model naming standardization: ToDo → Todo.

The model name has been updated to use standard capitalization convention. This maintains consistency with the same naming updates in the version-3.x documentation.

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

15-17: Documentation clarity improved: Output option now explicitly documented.

The output option has been reformatted with a clear description including type information, behavior (relative path resolution), and default value. This approach improves discoverability and reduces ambiguity for users.

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

15-29: Four new plugin options documented: output, lite, liteOnly, importWithFileExtension.

All options are clearly documented with type information, descriptions, and defaults. The formatting is consistent with the Prisma plugin documentation updates, improving documentation completeness and usability.

versioned_docs/version-3.x/recipe/auth-integration/better-auth.md (4)

1-51: Excellent new integration guide structure and setup documentation.

The Better-Auth integration section is well-organized with clear installation steps, configuration examples, and schema generation guidance. The use of custom components (<PackageInstall />, <PackageExec />) maintains documentation consistency with the rest of the site.

---

52-114: Access control integration clearly explained with practical examples.

The section on integrating better-auth with ZenStack's access control is comprehensive, progressing logically from basic user-bound ORM clients to advanced multi-tenant organization plugin support. Code examples are syntactically correct and demonstrate real-world usage patterns.

---

77-81: Verify API methods match current ZenStack v3 and Better-Auth versions.

Please confirm that the following API references are accurate for the versions being documented:

• db.$setAuth() method signature and availability
• auth.api.getSession() and auth.api.getFullOrganization() availability
• zenstackAdapter function from @zenstackhq/better-auth package

Also verify that the sample project URL points to the correct branch: better-auth-zenstack-multitenancy/tree/zenstack-v3.

Also applies to: 112-113

---

130-144: Multi-tenant Todo model example is clear and actionable.

The model definition with organization relationships and access policies demonstrates practical usage of the auth context in policy rules. The example effectively shows deny-then-allow pattern for security.

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

24-24: Excellent documentation improvements for clarity and completeness.

The changes consistently enhance the datasource reference by:

1. Explicit required/optional status (lines 24, 31, 43, 47): Clearly marking provider as "Required" and other fields as "Optional" improves user understanding at a glance.

2. New directUrl field (lines 35–39): Documenting this option and its relationship to Prisma Migrate for connection poolers is appropriate for the beta release and helps users with advanced database setups.

3. PostgreSQL-specific clarifications (lines 43, 47): Explicitly noting PostgreSQL-only constraints for defaultSchema and schemas prevents confusion for SQLite users.

4. Enhanced descriptions: The expanded explanation of the url field clarifies that it's migration-engine-only and includes provider-specific examples, making the documentation more actionable.

Also applies to: 31-31, 35-39, 43-43, 47-47