From 89ece928dc2d11818aaae0f6924b2aed0cdf8822 Mon Sep 17 00:00:00 2001 From: vingrad Date: Thu, 11 Jun 2026 00:59:26 +0200 Subject: [PATCH] Add a system-flow diagram to the README intro MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A Mermaid flowchart of the core loop β€” goal in, ranked plan out, immutable versions, signals through the materiality gate, outcomes recorded back β€” now opens the README. The ASCII arrow list in "Core idea" said the same thing lower down, so it is folded into the new diagram and the section keeps only its prose. --- README.md | 36 +++++++++++++++--------------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a4d6af7..2c403b1 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ It is built for use cases where a system should not simply ask an LLM β€œwhat sh The project focuses on **decision infrastructure**, not chatbot coaching. +How it works at a glance: + +```mermaid +flowchart TD + G["🎯 Goal
context Β· assets Β· constraints"] --> E["Decision Engine"] + E --> P["Ranked action plan
moves Β· experiments Β· fallbacks Β· provenance"] + P --> V[("Immutable plan versions
v1 β†’ v2 β†’ …")] + S["πŸ“‘ Signal
new information"] --> M{"material?"} + M -- "yes β€” replan" --> E + M -- "no β€” version stands, audited" --> V + O["βœ… Outcome
recorded result"] --> V + V -. "world changes" .-> S +``` + --- ## Why this exists @@ -43,27 +57,7 @@ This project explores how to build that as a clean, scalable backend component. ## Core idea -```text -Goal - + Context - + Assets - + Constraints - + Signals - + Outcomes - + Live data (fetched from external sources at decision time) - ↓ -Decision Engine - ↓ -Ranked Action Plan - ↓ -Versioned Plan State - ↓ -New Signals / Outcomes - ↓ -Replanning -``` - -Instead of returning a single `next_best_action`, the engine returns ranked action paths with rationale, experiments, fallbacks, and provenance. +Instead of returning a single `next_best_action`, the engine returns ranked action paths with rationale, experiments, fallbacks, and provenance β€” and keeps them versioned as the world changes (see the flow above). ---