Skip to content

Commit cfba1f2

Browse files
committed
Add Mermaid data-flow diagram to README
1 parent 0a44acf commit cfba1f2

1 file changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,20 @@ The three packages share contract identifiers (`source_id`, `document_id`, `chun
2222

2323
Data flow:
2424

25-
```text
26-
sources ──▶ knowledge_ingestion ──▶ documents.jsonl, chunks.jsonl, lineage.jsonl
27-
28-
29-
runtime ──▶ observability_analytics ──▶ interactions.jsonl, retrieval_traces.jsonl
30-
31-
32-
dataset_foundry ──▶ prompt_response.jsonl,
33-
retrieval_evaluation.jsonl,
34-
split_assignments.jsonl,
35-
dataset_manifest.json
25+
```mermaid
26+
flowchart TD
27+
sources([source documents]) --> KI[knowledge_ingestion]
28+
runtime([runtime LLM traces]) --> OA[observability_analytics]
29+
30+
KI --> docs[documents.jsonl<br/>chunks.jsonl<br/>lineage.jsonl]
31+
OA --> traces[interactions.jsonl<br/>retrieval_traces.jsonl]
32+
33+
docs --> DF[dataset_foundry]
34+
traces --> DF
35+
DF --> out[prompt_response.jsonl<br/>retrieval_evaluation.jsonl<br/>split_assignments.jsonl<br/>dataset_manifest.json]
36+
37+
classDef pkg fill:#2a6db2,stroke:#1b4a7a,color:#fff;
38+
class KI,OA,DF pkg;
3639
```
3740

3841
See [docs/architecture.md](docs/architecture.md) for boundaries and [docs/integration.md](docs/integration.md) for the full handoff contract.

0 commit comments

Comments
 (0)