docs(readme): rewrite the v2.0 section around what the user gains - #259
Merged
Conversation
The previous heading ("one role file, two generated permission files")
described the mechanism, not the benefit — it invited "so what if two
files got generated?" Rewritten to lead with the outcome: give each team
its own permissions without hand-writing config.
Replaces the abstract framing with measured numbers from an actual run
of `aigis profile build profiles/marketing.json`:
input profiles/marketing.json 15 lines, 6 choices
output aigis-policy.yaml 191 lines, 30 rules
output .claude/settings.json 26 permission rules
reported 10 of 30 rules that can't be expressed in Claude Code syntax
Also states the two things the Claude Code layer is actually for, which
the old text left implicit: it is evaluated before any hook runs, and
`--managed` produces the managed-settings.json form that no other
settings level can override.
Signed-off-by: killertcell428 <killertcell428@gmail.com>
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
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.
Why
The previous heading — "one role file, two generated permission files" — described the mechanism, not the benefit. It invited exactly the questions it should have answered: so what if two files got generated? Is the count the point? Did permission settings not exist before?
What changed
Leads with the outcome instead: give each team its own permissions without writing config by hand. Then answers the "why is that good" with numbers measured from an actual run of
aigis profile build profiles/marketing.json:profiles/marketing.json— 15 lines, 6 choicesaigis-policy.yaml— 191 lines, 30 rules.claude/settings.json— 26 permission rulesFour things the reader gets, each concrete:
aigis profile showoutput is readable by the person who approves it, unlike 191 lines of YAML--managedproduces themanaged-settings.jsonform that no other settings level can overrideAlso states plainly why there are two layers at all — Claude Code evaluates its own permission rules before any hook runs — since "why 2" was the unanswered question in the old text.
Verification
Numbers came from running the command, not from the docs:
Test plan
--managedflag confirmed present onprofile build(aigis/cli.py:330)