README overhaul and methodology-page roadmap sections - #17
Merged
Conversation
README: rewrite as a public-facing product README. Documents the five deterministic cards and the AI panel, the IR-centred pipeline and the Pyramid of Pain resolution rules as the methodology page states them, confidence/provenance labels (deterministic:static, deterministic:metadata, inferred:llm), static-vs-dynamic analysis framing, roadmap (dynamic analysis, Suricata/YARA parsers into the same IR, MCP server, evaluation history, per-reviewer tokens), a short Summiting the Pyramid comparison, local dev, testing, deployment, security notes, attribution, license. How this works: append three sections before the closing </main>, existing sections untouched: "Static analysis today, dynamic analysis next", "Deterministic checks for AI-assisted rule writing" (MCP/agentic roadmap), and "How this relates to Summiting the Pyramid". Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
SonarCloud analysis · PR #17Quality gate: ✅ Passed · Open in SonarCloud
Open issues on new code: 0No open issues on the changed code. 🎉 Commit |
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
deterministic:static,deterministic:metadata,inferred:llm); static-vs-dynamic analysis framing (dynamic explicitly not built); roadmap (dynamic analysis, Suricata/YARA as parallel parsers into the same IR, MCP server for agentic rule development, evaluation history, per-reviewer tokens); a two-paragraph Summiting the Pyramid comparison; local dev, testing, deployment, security notes, attribution, license. 237 lines. No "AST" wording anywhere.</main>, existing sections untouched: Static analysis today, dynamic analysis next; Deterministic checks for AI-assisted rule writing; How this relates to Summiting the Pyramid (links to ctid.mitre.org withtarget="_blank" rel="noreferrer").Verification
npx tsc --noEmit -p tsconfig.app.jsoncleannpx vite buildsucceedsReview focus
The Summiting the Pyramid paragraphs (README "Related work" and the last page section) make factual claims about the CTID methodology; please check them against the source before merging.
🤖 Generated with Claude Code