Skip to content

Conversation

@ymc9
Copy link
Member

@ymc9 ymc9 commented Jan 9, 2026

Summary by CodeRabbit

  • Documentation

    • Enhanced field-level access control documentation with interactive code samples.
  • Chores

    • Updated submodule references across documentation repositories to pull in the latest changes.

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

@vercel
Copy link

vercel bot commented Jan 9, 2026

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

Project Deployment Review Updated (UTC)
zenstack-new-site Ready Ready Preview, Comment Jan 9, 2026 0:23am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 9, 2026

Walkthrough

The PR updates 9 submodule pointers across v3-doc subprojects to track latest commits and adds a StackBlitzGithub interactive component to the field-level access control documentation page.

Changes

Cohort / File(s) Change Summary
Submodule pointer updates
code-repos/zenstackhq/v3-doc-orm, code-repos/zenstackhq/v3-doc-orm-computed-fields, code-repos/zenstackhq/v3-doc-orm-policy, code-repos/zenstackhq/v3-doc-orm-polymorphism, code-repos/zenstackhq/v3-doc-orm-typed-json, code-repos/zenstackhq/v3-doc-orm-validation, code-repos/zenstackhq/v3-doc-quick-start, code-repos/zenstackhq/v3-doc-server-adapter, code-repos/zenstackhq/v3-doc-tanstack-query
Nine submodule commit references advanced to latest commits; each file has exactly one line changed (+1/-1)
Documentation enhancement
docs/orm/access-control/field-level.md
Added StackBlitzGithub import and replaced sample placeholder with embedded StackBlitzGithub component pointing to v3-doc-orm-policy repo with specified start script and open files

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

🚥 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: field-level policy sample' clearly and specifically describes the main change: adding a field-level policy sample to the documentation.
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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @docs/orm/access-control/field-level.md:
- Line 61: The StackBlitzGithub component usage has an invalid repoPath; update
the repoPath prop on the StackBlitzGithub invocation to point to a valid public
repository that actually contains the referenced files and start script (e.g.,
change repoPath from "zenstackhq/v3-doc-orm-policy" to the correct repo such as
"zenstackhq/zenstack-v3" or another sandbox that includes
field-level/zenstack/schema.zmodel, field-level/main.ts and a "field-level"
script in package.json), or replace the entire StackBlitzGithub line with a link
to an alternative working example repository that contains those files.
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bb6b5b9 and 4036c73.

📒 Files selected for processing (10)
  • code-repos/zenstackhq/v3-doc-orm
  • code-repos/zenstackhq/v3-doc-orm-computed-fields
  • code-repos/zenstackhq/v3-doc-orm-policy
  • code-repos/zenstackhq/v3-doc-orm-polymorphism
  • code-repos/zenstackhq/v3-doc-orm-typed-json
  • code-repos/zenstackhq/v3-doc-orm-validation
  • code-repos/zenstackhq/v3-doc-quick-start
  • code-repos/zenstackhq/v3-doc-server-adapter
  • code-repos/zenstackhq/v3-doc-tanstack-query
  • docs/orm/access-control/field-level.md
🔇 Additional comments (10)
code-repos/zenstackhq/v3-doc-orm-computed-fields (1)

1-1: Verify the submodule pointer update is necessary and consistent.

This is a submodule pointer update to track a new commit. To ensure this change is intentional and aligned with the PR objectives:

  1. Confirm that the new commit 70f33a304751bdca9a95c7823a6f4929c5291501 contains changes related to the "field-level policy sample" documentation objective.
  2. Verify consistency: The AI summary mentions 9 submodule pointers are being updated across v3-doc subprojects. Are all 9 updates part of this PR, and are they aligned with the same objective?
  3. Clarify whether updating the v3-doc-orm-computed-fields submodule (which appears to be about computed fields) is necessary for adding a field-level policy sample, or if this is a routine alignment of all v3-doc submodules to their latest commits.
docs/orm/access-control/field-level.md (1)

7-7: The StackBlitzGithub component exists at src/components/StackBlitzGithub.tsx and is properly exported with the correct interface. The import path and component usage are both correct.

code-repos/zenstackhq/v3-doc-quick-start (1)

1-1: ✓ Submodule pointer update is consistent with PR objectives.

This submodule pointer update is part of a coordinated refresh across multiple v3-doc projects to support the field-level policy documentation changes. The update aligns with the PR goal to add the StackBlitzGithub interactive component to the field-level access control documentation.

To verify the submodule update, please confirm that the new commit (3c4dd11b...) in this submodule contains the expected documentation or sample code that supports the field-level policy documentation enhancements mentioned in the PR objectives.

code-repos/zenstackhq/v3-doc-server-adapter (1)

1-1: Verify the submodule commit hash and update intent.

This change updates the submodule pointer to a new commit. Ensure the commit hash 36af52a71e493ac7e0ae4e42b0e49685cb31a276 is valid and that this submodule update aligns with the PR objective of adding a StackBlitzGithub interactive component to the field-level access control documentation.

Additionally, the PR objectives mention updating 9 submodule pointers total, but only this file was provided for review. If other submodule updates are part of this PR, verify they are all intentional and consistent.

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

1-1: Verify the submodule commit hash and update rationale.

This submodule pointer is being updated as part of a coordinated batch update across 9 v3-doc projects. Ensure that the new commit hash is valid and understand what changes it introduces (e.g., bug fixes, documentation updates, feature changes).

Since only this single submodule file was provided for review, I cannot assess whether all 9 submodule updates are aligned in scope and intent. Confirm that:

  • The commit hash exists and is reachable in the target repository
  • All submodule updates are intentional and coordinated
  • The changes in the submodule support the PR objective (field-level policy sample documentation)
code-repos/zenstackhq/v3-doc-orm-polymorphism (1)

1-1: Verify the target commit and substantive changes in this submodule update.

This PR updates a submodule pointer, but the actual code/documentation changes are not visible in the provided review context. The AI summary mentions the addition of a StackBlitzGithub component to field-level access control documentation, but the relevant file (docs/orm/access-control/field-level.md) is not included here.

Before approval, please confirm:

  1. What specific changes does commit 6d62cd2... introduce to the v3-doc-orm-polymorphism submodule?
  2. Are all 9 submodule pointer updates across the subprojects intentional and coordinated?
  3. Can you provide or confirm visibility into the documentation changes (field-level.md) mentioned in the PR summary?

If the submodule update is simply tracking upstream changes without introducing new issues, the update itself is mechanically sound. However, reviewing the actual substantive changes (the documentation additions) would help validate the overall PR intent.

code-repos/zenstackhq/v3-doc-tanstack-query (1)

1-1: Verify the submodule commit exists and contains the intended documentation.

This is a submodule pointer update as part of the field-level policy sample documentation effort. Ensure the new commit (eee39e06d2817de5653ded6a7ad42cdff4b5849b) is reachable in the upstream repository and contains the field-level access control documentation and StackBlitz component mentioned in the PR objectives.

Additionally, confirm that updating all 9 submodule pointers (as noted in the summary) is intentional for this PR. If this update is coordinated across multiple documentation subprojects, consider documenting the coordination in the PR description for clarity.

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

1-1: Submodule pointer updated to track new commit.

The submodule pointer has been updated to a new commit. Ensure the new commit contains the intended changes for the field-level policy sample documentation.

To confirm this submodule update is valid and complete, please verify:

  1. The new commit (96ce9b6f6e1d95872080c43ff03f141ba2b8c367) exists in the upstream repository
  2. The commit message or changes align with the PR objective: "field-level policy sample"
  3. The submodule clones successfully after this change

Additionally, note that the related documentation file (docs/orm/access-control/field-level.md) mentioned in the AI summary was not provided for review. If you'd like a comprehensive review of the documentation changes, please include that file in the next review round.

code-repos/zenstackhq/v3-doc-orm-typed-json (1)

1-1: Verify submodule commit and provide missing documentation file for review.

The provided file shows only a submodule pointer update. The AI-generated summary mentions code changes within the submodule (calculator.py) and a documentation change (field-level.md with StackBlitzGithub component), but:

  1. The actual code changes in the submodule commit are not visible here
  2. The docs/orm/access-control/field-level.md file mentioned in the summary is not included in the provided files

To complete the review, please clarify:

  • Are there actual source code changes in the submodule that should be reviewed, or is this purely a documentation example update?
  • Provide the field-level.md file so I can review the StackBlitzGithub component addition
code-repos/zenstackhq/v3-doc-orm (1)

1-1: Submodule pointer update — substantive documentation changes not provided for review.

This change updates the submodule pointer to a new commit (380e4760...), which is metadata-only. However, the actual documentation changes referenced in the AI summary (the StackBlitzGithub component additions to docs/orm/access-control/field-level.md) are not included in the provided files, preventing a full assessment of the PR's content.

To verify this change is correct, please confirm:

  1. The new commit hash 380e47603b708735d012c2235365ae8934f1e2a7 exists and is reachable in the zenstackhq/v3-doc-orm repository
  2. That commit contains the expected documentation updates (field-level access control examples with StackBlitzGithub samples)

@ymc9 ymc9 merged commit 06dc104 into main Jan 9, 2026
4 checks passed
@ymc9 ymc9 deleted the doc/field-level-policy-sample branch January 9, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants