Normalize tool README top-of-file structure#41
Merged
AndrewAltimit merged 1 commit intomainfrom Apr 26, 2026
Merged
Conversation
Apply consistent convention across ~41 tool READMEs: title → one-paragraph description → **Containment** notice → modules/usage Changes: - Replace disclaimer blockquotes with description paragraphs - Add explicit **Containment** line to every entry-point README - Fix lowercase and path-prefixed H1 titles - Remove redundant Containment/Lab Setup sections now covered upfront - Remove decorative --- horizontal rules between sections - Apply to all Rust library crates (consumed by beacon, gated by callers) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.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
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
**Containment**notice (env vars, lab target, ContainmentGuard reference) to every entry-point README that was missing one# tools/persistence,# lateral-movement,# edr-killer-class, etc.)**Focus:**,**Complement to:**,**Type:**/**Status:**metadata blocks)## Containment Summary/## Lab Setup/## Purposewrapper sections into the intro paragraphConvention applied: title -> one-paragraph description ->
**Containment**line -> modules/usage.Test plan
check_detection_pairing,check_no_committed_drivers,check_no_real_tenants) -- docs-only change, all passGenerated with Claude Code