Skip to content

docs: update healthcare example#2827

Merged
omer-topal merged 1 commit intomasterfrom
omer/fix-healthcare-example
Mar 11, 2026
Merged

docs: update healthcare example#2827
omer-topal merged 1 commit intomasterfrom
omer/fix-healthcare-example

Conversation

@omer-topal
Copy link
Copy Markdown
Contributor

@omer-topal omer-topal commented Mar 11, 2026

Summary by CodeRabbit

  • Documentation
    • Updated healthcare example with restructured entity models and simplified permission handling patterns
    • Introduced new schema-level rule pattern with enhanced documentation and descriptions
    • Improved example clarity by streamlining entity relationships and access control mechanisms

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

The healthcare example documentation was refactored to move the age-checking rule from an entity-level definition to a schema-level definition. The public state entity was removed, and the patient entity's parent_access permission was updated to reference the new schema-level check_age rule directly instead of through the state entity.

Changes

Cohort / File(s) Summary
Healthcare Documentation Refactoring
docs/getting-started/examples/healthcare.mdx
Removed public state entity and its check_age rule. Relocated check_age validation logic to schema level with age < 18 constraint. Updated patient entity's parent_access permission to reference the schema-level rule directly, eliminating unnecessary entity relation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Poem

🐰 A rule hops free from entity state,
Now schema-bound to validate,
Age checks age < eighteen days,
In cleaner, simpler docco ways!

🚥 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 'docs: update healthcare example' accurately describes the main change, which is updating the healthcare documentation example by refactoring the entity structure and rule definitions.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch omer/fix-healthcare-example

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.

@omer-topal
Copy link
Copy Markdown
Contributor Author

#2822 #2742

@omer-topal omer-topal merged commit 80ff388 into master Mar 11, 2026
7 of 12 checks passed
@omer-topal omer-topal deleted the omer/fix-healthcare-example branch March 11, 2026 14:17
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.

1 participant