fix: rewrite ARCHITECTURE.md to remove vendor coupling#56
Merged
Conversation
Task D2 from the neutrality-audit-phase-2 brief, depends on D1 (rules/ removed, #54) and applied as one coordinated rewrite, not five independent changes: - Repo layout diagram: dropped the rules/ block entirely (D1 already removed the directory); tests/fixtures/ description now explains the conformance-fixture model - The "record -> rule -> fixture triangle" diagram replaced with "record and conformance fixture relationship" -- dotted lines to an external IMPL node instead of a RULE node this repo no longer has - "How the scanner consumes this repo" -> "How an implementation consumes this repo": dropped the rules/pattern -> PatternEngine / rules/yara -> YARAEngine / rules/semgrep -> SemgrepEngine rows (those engines belong to bawbel-scanner specifically); the PiranhaDB/ api.piranha.bawbel.io mention replaced with a generic "any other service, including any Bawbel-operated one, is documented in its own repo" per CONTEXT.md - Five detection layers table: dropped "(bawbel scan)" / "(bawbel scan-server-card)" CLI names from the "Scanner that reaches it" column - Recounted both stale figures against the live 59-record corpus: "33 of 48" -> "37 of 59" (content layer), "12 records" -> "15 records" (runtime layer) One deviation from the brief as drafted: two of its replacement paragraphs cited `TRUST_STRATEGY.md` by name as supporting evidence. That file is deliberately kept out of this repo (gitignored, per CONTEXT.md's own separation rule) -- citing it from a document any second implementer or OWASP reviewer will read would point them at a file they can't see, the same problem this rewrite exists to fix. Repointed both citations to CONTEXT.md instead, which is in the repo. All 59 records still validate; full fixture-conformance suite (236 tests) passes.
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
Task D2 from the neutrality-audit-phase-2 brief. Depends on D1 (#54, merged) since this rewrite assumes `rules/` no longer exists. Applied as one coordinated rewrite, not five independent changes, per the brief's own instruction.
One deviation from the brief as drafted: two of its replacement paragraphs cited `TRUST_STRATEGY.md` by name as supporting evidence. That file is deliberately kept out of this repo (gitignored, per `CONTEXT.md`'s own separation rule) -- citing it from a document any second implementer or OWASP reviewer will read would point them at a file they can't see, the same problem this rewrite exists to fix. Repointed both citations to `CONTEXT.md` instead, which is actually in the repo.
Test plan