docs: add strict mode guide and rewrite OPL reference for Keto#2573
docs: add strict mode guide and rewrite OPL reference for Keto#2573DavudSafarli wants to merge 3 commits into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR adds a single documentation navigation entry to the Keto guides section of the sidebar configuration, linking to the new strict-mode guide under the "Fine-grained Permissions" category. ChangesDocumentation sidebar navigation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
This PR expands Ory Permissions (Keto) documentation by adding a new guide explaining “strict mode” and by rewriting the Ory Permission Language (OPL) reference from a formal specification into a practical, example-driven how-to.
Changes:
- Added a new “Strict mode” guide covering behavior changes, breaking patterns, and readiness checks.
- Reworked the OPL reference page into a structured guide (namespaces, relations, subject sets, permits) with examples.
- Added the new guide to the network sidebar under Keto guides.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sidebars-network.ts | Adds the new strict mode guide to the Keto guides sidebar list. |
| docs/keto/reference/ory-permission-language.mdx | Rewrites the OPL reference into a practical guide with examples. |
| docs/keto/guides/strict-mode.mdx | Introduces a new guide explaining strict mode, expected behavior changes, and audits. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
c351bc2 to
c0700fa
Compare
Adds a new guide what "strict mode" is, why and how to enable it, known breaking patterns with examples, and how to audit your app before enabling.
Rewrites OPL into a practical how-to guide covering namespaces, relations, subject-set references, and permits, each section with examples.
Summary by CodeRabbit