Skip to content

docs(readme): architecture diagram, runnable demo, and the over-built note#83

Merged
JumpTechCode merged 2 commits into
mainfrom
docs/readme-demo-presentation
Jun 16, 2026
Merged

docs(readme): architecture diagram, runnable demo, and the over-built note#83
JumpTechCode merged 2 commits into
mainfrom
docs/readme-demo-presentation

Conversation

@JumpTechCode

Copy link
Copy Markdown
Collaborator

Presentation pass so the README lands as an architecture showcase (no new subsystems — diagram, runnable demo, claim integrity).

Changes

  • Visual architecture diagram. Replaced the ASCII box-art with a GitHub-rendered mermaid flowchart of the webhook → outbox → Kafka → enrichment → diagnosis flow (with pgvector memory and embed-on-resolve).
  • "See it run — webhook to diagnosis". A copy-paste path: make compose-upmake migrate → an HMAC-signed curl to /webhooks/generic → poll /incidents/<id>. It produces a real diagnosis. The bare-stack output deliberately shows the evidence-citation gate working — with no real integrations wired there's nothing to cite, so it strips the invented refs, flags hallucinated_evidence, and caps confidence — and points to the eval results for the full-context numbers. Prereqs (bootstrap, .env, the generic secret, jq/openssl) are called out so it runs top-to-bottom.
  • "Isn't this over-built?" note backed by new ADR 0015 — names the trade-off (deliberate production patterns for a portfolio) and the honest simplification (collapse Kafka into the outbox-as-queue for a real single-tenant deploy).

Verified

  • Every command was run live against the stack: signed webhook → 202, diagnosis produced and served via the API.
  • The illustrative diagnosis JSON matches the real API response field-for-field (likely_category, confidence, hypothesis, hallucinated_evidence, evidence, suggested_actions[].{description,command,risk,rationale,requires_human_approval}).
  • Mermaid syntax is conservative (quoted labels, standard shapes) and renders on GitHub.
  • Senior doc review (claim-integrity focused): the two Important findings — demo prerequisites and jq — are fixed in this PR.

Pairs with the foundational fixes landed alongside it (#79 temperature, #81 observability wiring, #80 multistage image, #82 prompt packaging) so every claim the README makes is now backed by the code.

🤖 Generated with Claude Code

JumpTechCode and others added 2 commits June 16, 2026 02:02
… note

Three presentation changes so the README lands as an architecture showcase:

- Replace the ASCII architecture box-art with a GitHub-rendered mermaid flowchart
  of the webhook → outbox → Kafka → enrichment → diagnosis flow.
- Add a "See it run" section: a copy-paste make compose-up → migrate →
  HMAC-signed webhook → poll path that produces a real diagnosis. The bare-stack
  output shows the evidence-citation gate doing its job — no verifiable evidence
  to cite, so it strips the invented refs, flags hallucinated_evidence, and caps
  confidence — with a pointer to the eval results for the full-context numbers.
- Add a short, honest "isn't this over-built?" note backed by a new
  ADR 0015 (deliberate production patterns, and when to collapse Kafka into the
  outbox-as-queue).

Demo commands verified live against the stack; the illustrative diagnosis JSON
matches the real API response field-for-field.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@JumpTechCode
JumpTechCode merged commit 8563140 into main Jun 16, 2026
6 checks 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