doc: custom procedures sample

[ymc9]

Summary by CodeRabbit

• Documentation
  • Added interactive code samples for custom ORM procedures documentation.
  • Updated ORM polymorphism documentation examples with refined configuration.

_{✏️ 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	Review	Updated (UTC)
zenstack-new-site	Ready	Preview, Comment	Jan 9, 2026 0:52am

[coderabbitai]

Walkthrough

This PR adds a new Git submodule for documentation purposes (v3-doc-orm-procedure), updates an existing submodule reference (v3-doc-plugin), and enhances ORM documentation by introducing a new code sample section and refactoring StackBlitz component usage patterns across multiple files.

Changes

Cohort / File(s)	Summary
Git submodule management .gitmodules, code-repos/zenstackhq/v3-doc-orm-procedure, code-repos/zenstackhq/v3-doc-plugin	Added new submodule entry for v3-doc-orm-procedure with commit reference. Updated v3-doc-plugin submodule pointer from 7807a35 to 26575d2.
Documentation updates docs/orm/custom-proc.md	Added StackBlitzGithub import and new Samples section that embeds a StackBlitz code example.
Documentation component refactoring docs/orm/polymorphism.md	Modified StackBlitzGithub usage from codeFiles prop to openFile prop and simplified startScript from "generate,dev" to "dev".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• doc: custom procedures #548 — Both PRs directly modify docs/orm/custom-proc.md to add custom procedure documentation and samples.
• doc: v3.2.0 release #552 — Both PRs modify docs/orm/custom-proc.md with complementary documentation enhancements.
• doc: plugin development guide #527 — Main PR updates StackBlitzGithub component usage patterns that depend on component changes introduced in the retrieved PR.

🚥 Pre-merge checks | ✅ 3

✅ 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 'doc: custom procedures sample' is specific and clearly related to the main change: adding documentation and a StackBlitz sample for custom procedures, as evidenced by the new docs/orm/custom-proc.md file and the introduction of the Samples section with embedded examples.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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

🤖 Fix all issues with AI agents

In @docs/orm/custom-proc.md:
- Around line 101-103: The StackBlitz sample references a submodule repoPath
'zenstackhq/v3-doc-orm-procedure' via the StackBlitzGithub component but the
submodule is empty; initialize that submodule with the expected directory
structure and files: add zenstack/schema.zmodel and main.ts at the root of the
submodule and create a package.json that includes a "dev" script (or the script
name referenced by startScript) so the StackBlitzGithub component can open and
run the project; commit and push the populated submodule so the component can
load.

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06dc104 and aa379ec.

📒 Files selected for processing (5)

• .gitmodules
• code-repos/zenstackhq/v3-doc-orm-procedure
• code-repos/zenstackhq/v3-doc-plugin
• docs/orm/custom-proc.md
• docs/orm/polymorphism.md

🔇 Additional comments (4)

.gitmodules (1)

34-36: ✓ New submodule entry properly formatted and follows naming conventions.

The new submodule entry for v3-doc-orm-procedure is correctly structured with proper indentation, naming convention (code-repos/zenstackhq/*), matching path, and URL format.

Note: The URL includes the .git suffix, consistent with 9 of the 12 existing entries. A few entries (lines 27, 30, 33) omit it. Both formats work, but consider standardizing across the file in a future cleanup if needed.

code-repos/zenstackhq/v3-doc-orm-procedure (1)

1-1: No action required. The .gitmodules file is properly configured with the correct entry for v3-doc-orm-procedure (lines 34-36), including a valid GitHub repository URL. The submodule configuration follows the standard pattern used across the project and is ready for initialization.

docs/orm/custom-proc.md (1)

8-8: Import added correctly.

The StackBlitzGithub component import follows the established pattern used in other documentation files.

code-repos/zenstackhq/v3-doc-plugin (1)

1-1: Verify the submodule commit hash and confirm alignment with documentation changes.

This PR updates the v3-doc-plugin submodule reference, but the provided review context is incomplete. The AI summary references other files in the PR (.gitmodules, docs/orm/custom-proc.md, docs/orm/polymorphism.md) that are not included in the review.

To complete the review, please verify:

1. Whether the new commit hash (26575d2160a8d4db6eedf94a00580dd76d256dd7) is valid and exists in the v3-doc-plugin repository.
2. What changes are being introduced by this submodule update.
3. Whether this update is consistent with the documentation changes mentioned in the AI summary (custom procedures sample, StackBlitzGithub refactoring).

Additionally, please provide the other files referenced in the PR (particularly .gitmodules and the updated documentation files) so the review can assess the full scope of changes.