doc: v3 release beta.25

[ymc9]

Summary by CodeRabbit

• New Features

  • Added format CLI command for formatting ZModel schema files.
  • Introduced seed workflow with new seed and db seed CLI commands for database seeding, including seed script configuration options.

• Documentation

  • Added reference to Multi-tenant Todo sample project.

_{✏️ 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	Nov 20, 2025 7:55pm

[coderabbitai]

Walkthrough

Adds documentation for two new CLI features: a format command for formatting ZModel schema files and a seed workflow for database seeding (including seed and db seed commands). Also introduces a new "Multi-tenant Todo" sample project entry to the samples documentation.

Changes

Cohort / File(s)	Summary
CLI reference updates versioned_docs/version-3.x/reference/cli.md	Documents new format command for schema formatting and new seed workflow including seed and db seed commands. Specifies seed script configuration in package.json, execution behavior after reset/deploy contexts, and --skip-seed option.
Sample project additions versioned_docs/version-3.x/samples.md	Adds "Multi-tenant Todo" section with link to Next.js-based multi-tenant example and brief description.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Documentation-only changes with no logic modifications
• CLI documentation additions are straightforward reference content
• Sample entry addition is minimal

Possibly related PRs

• docs: release 2.8.0 #381 — Overlaps on CLI documentation additions for format command and seed/db seed workflows
• docs: update Zenstack typo #406 — Both modify seed-related CLI documentation covering seed scripts and db seed workflow
• doc: v3 tanstack-query docs #502 — Both modify the same cli.md reference file, adding different CLI command/option documentation
• blog: stack-auth multi-tenant app #402 — Adds the corresponding blog/stackauth-multitenancy/index.mdx multi-tenant Todo example file that this PR references in samples

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'doc: v3 release beta.25' is vague and generic—it uses only a version number without describing the actual changes being made. While it indicates documentation updates for a release, it does not convey what specific content or features are being documented.	Consider using a more descriptive title like 'doc: add v3 CLI format and seed commands documentation' to clearly communicate the main changes in the changeset.

✅ 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 doc/release-beta.25

---

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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f3172f4 and 96b2c5d.

📒 Files selected for processing (2)

• versioned_docs/version-3.x/reference/cli.md (4 hunks)
• versioned_docs/version-3.x/samples.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

versioned_docs/version-3.x/samples.md

18-18: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)

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

274-287: Comprehensive and well-structured CLI documentation for new features.

The documentation additions for the format command and db seed functionality are clear, comprehensive, and properly integrated into the existing CLI reference. The format is consistent with other command documentation sections, including:

• Clear usage syntax
• Descriptive text
• Well-organized options
• Practical configuration examples (seed script in package.json)
• Examples of argument passing with --

The added note at Line 117 about seed script execution after migrate reset provides helpful context for users.