docs(readme): tone down bold-headline paragraphs and marketing language - #258
Merged
Conversation
Replace paragraph-opening bold "headlines" (**Two-layer defense —**,
**On the audit gap.**, **MCP tool poisoning** —, etc.) with real ###
subheadings or plain sentences, cut self-referential marketing phrasing
("Aigis is the layer that answers it"), and trim bold runs inside single
sentences down to one emphasis point where one is still useful. Also
rewrites the v2.0 section for clarity (what was built, in plain terms)
and drops the "260+ patterns" count that contradicted the "stopped
competing on pattern count" framing introduced in v2.0.
No structural changes: existing anchor IDs (#for-security-teams,
#why-aigis, #limits, #learn-more) are untouched, only new ### subheadings
were added underneath them.
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 README had drifted into a pattern of paragraph-opening bold "headlines" (
**Two-layer defense —**,**On the audit gap.**,**MCP tool poisoning** —, ...) plus some self-referential marketing phrasing ("Aigis is the layer that answers it"). For a security-team audience this reads as more sales pitch than technical documentation.###subheadings where they were acting as section breaks, or plain sentences where they weren'taigis profile buildreads one role file, writes two permission files) instead of the "stops competing on pattern count" framing, which didn't explain the featureNot changed
#for-security-teams,#why-aigis,#limits,#learn-more,#quick-start) are untouched — new###subheadings were added underneath them, not replacing themTest plan