docs(readme): architecture diagram, runnable demo, and the over-built note#83
Merged
Conversation
… 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>
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.
Presentation pass so the README lands as an architecture showcase (no new subsystems — diagram, runnable demo, claim integrity).
Changes
webhook → outbox → Kafka → enrichment → diagnosisflow (with pgvector memory and embed-on-resolve).make compose-up→make migrate→ an HMAC-signedcurlto/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, flagshallucinated_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.Verified
202, diagnosis produced and served via the API.likely_category,confidence,hypothesis,hallucinated_evidence,evidence,suggested_actions[].{description,command,risk,rationale,requires_human_approval}).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