docs: retire "static analyzer", disambiguate from rulebook, drop stal… - #44
Merged
Merged
Conversation
…e counts Punchlist v7 items 5, 18 and 56. Item 18 - the README led with "the static analyzer for agent reliability", which the terminology table retires as a lead. Replaced with the AI agent reliability framing, and the opening now states what this repo is AND what it is not: these are the YAML packs the engine resolves at scan time, while the threat model and rationale live in trustabl-rulebook. The two names are one syllable apart and the distinction is load-bearing - one is Apache-2.0 and read by the scanner, the other is documentation the scanner never reads. Item 5 - banner alt was bare "Trustabl". Now describes the artifact, with the pack list as visible prose below the banner where it is indexed and quotable rather than stuffed into an alt attribute. Item 56 - removed "Total: 102 rules across 45 yaml files" and the four per-pack counts. All five were stale: the repo holds 84 yaml files across ten packs and the engine badge reads 193. Counting yaml files undercounts because one file can hold several rules; trustabl rules validate is the authoritative count. Also flagged, not fixed: the Layout tree documents only the four original packs. claude_skill, langchain, crewai, autogen, pydantic_ai and vercel_ai ship today and are undocumented. Added a pointer to the directory listing rather than inventing rule-ID mappings that have not been verified.
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.
…e counts
Punchlist v7 items 5, 18 and 56.
Item 18 - the README led with "the static analyzer for agent reliability", which the terminology table retires as a lead. Replaced with the AI agent reliability framing, and the opening now states what this repo is AND what it is not: these are the YAML packs the engine resolves at scan time, while the threat model and rationale live in trustabl-rulebook. The two names are one syllable apart and the distinction is load-bearing - one is Apache-2.0 and read by the scanner, the other is documentation the scanner never reads.
Item 5 - banner alt was bare "Trustabl". Now describes the artifact, with the pack list as visible prose below the banner where it is indexed and quotable rather than stuffed into an alt attribute.
Item 56 - removed "Total: 102 rules across 45 yaml files" and the four per-pack counts. All five were stale: the repo holds 84 yaml files across ten packs and the engine badge reads 193. Counting yaml files undercounts because one file can hold several rules; trustabl rules validate is the authoritative count.
Also flagged, not fixed: the Layout tree documents only the four original packs. claude_skill, langchain, crewai, autogen, pydantic_ai and vercel_ai ship today and are undocumented. Added a pointer to the directory listing rather than inventing rule-ID mappings that have not been verified.