docs: highlight grants DSL in README quick start#5
Merged
C-Sinclair merged 1 commit intomainfrom Apr 21, 2026
Merged
Conversation
PR #3 merged the declarative grants DSL but left the README showing the old imperative-resolver pattern. This commit: - Adds the grants DSL to the feature list at the top - Replaces the Quick Start code sample to use a grants block (RBAC for admin/editor/viewer) instead of a case-statement resolver - Documents the function-form resolver as the mutually-exclusive escape hatch for runtime instance-specific permissions No code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PR #3 merged the declarative `grants` DSL, but the README's Quick Start
still showcased the old imperative-resolver pattern. This PR updates the
docs to reflect what the library actually recommends now:
with an equivalent `grants do … end` block (admin/editor/viewer RBAC).
escape hatch for runtime instance-specific permissions (DB-backed per-row
sharing).
No code changes.
Test plan
`test/ash_grant/grants_integration_test.exs` (admin, editor, viewer
grants + `:own`/`:published` scopes), so it compiles and the
described behavior matches what the test suite verifies