Skip to content

README overhaul and methodology-page roadmap sections - #17

Merged
dgunter merged 1 commit into
mainfrom
phase2/readme-and-roadmap
Sep 4, 2026
Merged

README overhaul and methodology-page roadmap sections#17
dgunter merged 1 commit into
mainfrom
phase2/readme-and-roadmap

Conversation

@dgunter

@dgunter dgunter commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Summary

  • README.md: rewritten as a public-facing product README. Covers the five deterministic cards and the AI panel; the IR-centred pipeline (YAML → pySigma → normalized IR, built once, walked by every stage); the Pyramid of Pain resolution rules exactly as the methodology page states them (AND-min, OR-max, filters excluded but reported, TTP escalation ≥ tier 4 across ≥ 2 categories, bare NOT as allowlist at medium confidence, routing/outcome fields as context); confidence + provenance labels (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.
  • How this works page: three new sections appended before </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 with target="_blank" rel="noreferrer").

Verification

  • npx tsc --noEmit -p tsconfig.app.json clean
  • npx vite build succeeds

Review 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

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>
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

SonarCloud analysis · PR #17

Quality gate: ✅ Passed · Open in SonarCloud

Condition Actual Required Status
Reliability rating (new code) A ≤ A
Security rating (new code) A ≤ A
Maintainability rating (new code) A ≤ A
Duplication (new code) 0.0% ≤ 3.0%
Security hotspots reviewed 100.0% ≥ 100.0%

Open issues on new code: 0

No open issues on the changed code. 🎉

Commit 4981b95bfb8e · analysis task · posted by the Build workflow; edited in place on every push.

@dgunter
dgunter merged commit b54b5f3 into main Sep 4, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant