docs(readme): lead the v2.0 section with what it does for you, cut the rest - #261
Merged
Merged
Conversation
…e rest The v2.0 section explained how profile build works before saying why anyone would run it, so a platform lead skimming the README could not tell what they gained. It now opens with the problem (two hand-written config files per team, Claude Code's rules evaluated before the hook, so one of them is always stale), shows the two commands, and lists four concrete outcomes. The two design-choice paragraphs (no allowlist for shell, three values for git) move into a details block — kept, but off the main line. Also: - Drop the Qiita article table from README.ja.md. The English README never had it, and it sat between the benchmarks link and Contributing where nobody reading for evaluation would want it. - Shrink the v1.2 section to a heading, one paragraph and the GIF, now that v2.0 is the headline feature. - Collapse "Two layers", "The audit gap" and "The key's location" into one section with a new #audit-key anchor, and point the detail at docs/adoption/. The IT-question table link is repointed at the new anchor. - Remove "Why an independent OSS layer". The acquisition list is still in the FAQ, which is where a reader asking that question looks. - Rewrite "Why Aigis?" so each of the three agent-specific attacks says why an input/output filter does not see it: the MCP definition is read as an instruction, the planted memory fires in a later session with no attacker input present, the retrieved page was never typed by the user. The attack- surface table moves below them. Numbers re-measured against `aigis profile build profiles/marketing.json`: 15-line role, 191-line policy, 30 rules, 26 permission rules, 10 not expressible. Corrected the claim that profile build prints a reason and an alternative per excluded rule — it prints rule IDs; `aigis settings` prints why/fix. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> 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.
Summary
The v2.0 section explained how
aigis profile buildworks before saying why anyone would run it, so an IT/platform reader skimming the README could not tell what they gained. This rewrites that section around the outcome, cuts three sub-sections that were too detailed for a README, and makes "Why Aigis?" answer why an input/output filter misses the three agent-specific attacks instead of just naming them.Documentation only — no code changes. Both
README.mdandREADME.ja.mdstay in sync.Changes
shellhas no allowlist,githas three values) move into a<details>block — kept, off the main line.aigis profile build profiles/marketing.json: 15-line role file → 191-line policy (30 rules) + 26 Claude Code permission rules, 10 not expressible.profile buildprints excluded rule IDs only; thewhy:/fix:lines come fromaigis settings. The README saidprofile buildprinted a reason and a hand-written alternative for each.#audit-keyanchor; detail moved to links intodocs/adoption/. The IT-question table's[details]link is repointed at the new anchor.README.ja.md. The English README never had it, and it sat between the benchmarks link and Contributing.Type of change
Testing
pytest tests/ -vpasses locally — not run; no code changed#audit-keyand the repointed table link)Checklist
CHANGELOG.mdupdated under[Unreleased]— not applicable, README-only changeScreenshots / output
wc -l:profiles/marketing.json15 · generatedaigis-policy.yaml191.🤖 Generated with Claude Code