doc: v3 beta.27 release

[ymc9]

Summary by CodeRabbit

• Documentation
  • Enhanced FAQ with explicit runtime testing status for Node.js (fully tested), Bun, Vercel Edge Runtime (end-to-end tests), and Deno (not tested).
  • Added Bun-specific SQLite driver setup guide with detailed configuration and code examples.
  • Added Rallly as a new sample project showcasing ZenStack v3 implementation.

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

[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	Dec 2, 2025 5:47am

[coderabbitai]

Walkthrough

Documentation updates across three files expand multi-runtime support guidance. FAQ now explicitly enumerates runtime statuses (Node.js systematically tested; Bun and Vercel Edge basic tests; Deno untested). SQLite recipe adds Bun-specific setup and code examples. Sample projects section introduces a Rallly fork reference.

Changes

Cohort / File(s)	Summary
Runtime support status documentation versioned_docs/version-3.x/faq.md	Replaces generic Node.js testing statement with explicit enumerated runtimes and their support statuses—Node.js systematically tested, Bun/Vercel Edge basic end-to-end tests, Deno not tested.
Database recipe with multi-runtime guidance versioned_docs/version-3.x/recipe/databases/sqlite.md	Restructures SQLite guide to separate Node.js and Bun sections. Adds Bun-specific dialect and driver guidance (kysely-bun-sqlite, bun:sqlite) with complete code example. Preserves existing Node.js (better-sqlite3) example.
Sample projects versioned_docs/version-3.x/samples.md	Adds new Rallly sample project section with link to ZenStack fork, noting replacement of Prisma with ZenStack v3.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify factual accuracy of runtime support claims (Node.js, Bun, Vercel Edge, Deno statuses)
• Confirm Bun-specific code examples are syntactically correct and follow ZenStack patterns
• Validate Rallly sample project link and description accuracy

Possibly related PRs

• doc: v3 db recipes #523: Overlaps on sqlite.md file modifications, adding/reorganizing SQLite and Bun guidance for database setup.
• doc: misc updates #519: Directly related to FAQ runtime support status updates, previously introduced brief note on tested runtimes.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'doc: v3 beta.27 release' is vague and generic, using non-descriptive terms that don't convey specific information about the changeset's content.	Consider a more specific title that highlights the main changes, such as 'doc: add multi-runtime support documentation for v3 beta.27' or 'doc: document Node.js, Bun, and Deno runtime support'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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 test/edge-runtime

---

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

🧹 Nitpick comments (1)

versioned_docs/version-3.x/recipe/databases/sqlite.md (1)

28-47: Bun section well-structured; minor wording improvements recommended.

The new Bun section provides clear setup guidance, proper package dependency, and a working code example. However, two minor improvements are suggested:

1. Line 32: Change "builtin" to "built-in" (hyphenated for proper English)
2. Line 32: Optionally change "not compatible" to "incompatible" for conciseness

Apply this diff for the wording improvements:

-Bun is not compatible with `better-sqlite3`. You can use its builtin `bun:sqlite` module with the `kysely-bun-sqlite` Kysely community dialect.
+Bun is incompatible with `better-sqlite3`. You can use its built-in `bun:sqlite` module with the `kysely-bun-sqlite` Kysely community dialect.

Please verify that the package references (kysely-bun-sqlite) and import paths (bun:sqlite, BunSqliteDialect) are current and match the latest library documentation, as Bun's ecosystem is rapidly evolving.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8616368 and 8be10a1.

📒 Files selected for processing (3)

• versioned_docs/version-3.x/faq.md (1 hunks)
• versioned_docs/version-3.x/recipe/databases/sqlite.md (2 hunks)
• versioned_docs/version-3.x/samples.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

versioned_docs/version-3.x/samples.md

[grammar] ~22-~22: Ensure spelling is correct
Context: ...s, TanStack Query, and ZenStack v3. ## Rallly https://github.com/zenstackhq/rallly [R...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

versioned_docs/version-3.x/recipe/databases/sqlite.md

[style] ~32-~32: Consider using “incompatible” to avoid wordiness.
Context: ... ## Bun ### Installing driver Bun is not compatible with better-sqlite3. You can use its ...

(NOT_ABLE_PREMIUM)

---

[grammar] ~32-~32: Ensure spelling is correct
Context: ... with better-sqlite3. You can use its builtin bun:sqlite module with the `kysely-bu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)

versioned_docs/version-3.x/samples.md

24-24: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (3)

versioned_docs/version-3.x/samples.md (1)

22-26: Sample project entry is well-structured and adds valuable reference.

The Rallly fork description clearly communicates the value (replaces Prisma with ZenStack v3) and fits naturally with existing samples.

versioned_docs/version-3.x/recipe/databases/sqlite.md (1)

9-26: Node.js section restructuring improves clarity.

Nesting "Installing driver" under a "Node.js" heading clearly distinguishes this from other runtime options and improves documentation navigation.

versioned_docs/version-3.x/faq.md (1)

17-20: Clear and informative runtime support statement.

The explicit enumeration of runtime testing statuses (Node.js systematically tested; Bun and Vercel Edge basic tests; Deno untested) provides actionable clarity for users evaluating ZenStack v3 compatibility. This aligns well with the Bun-specific guidance added in the SQLite recipe and reflects the broader multi-runtime support improvements in this release.