Skip to content

Commit 87d1273

Browse files
GottZclaude
andcommitted
docs(readme): animierte Architektur-Infografik als SVG (light + dark)
Umfangreiche How-ctx-works-Infografik im README-Kopf: Access-Pfade, Store-Pipeline (Time anchors, Embedding, Guard-Dedup-Verzweigung), Query-Pipeline (Temporal parser, 4-Way RRF 0.45/0.25/0.20/0.10, Gravity, Graph expand, Fold, Synthesis) und Dream-Mode-Loop. Animiertes selbstgezeichnetes SVG (CSS stroke-dashoffset-Flow, prefers-reduced-motion-Fallback) statt GIF; Theme-Auswahl via GitHub-<picture>-Mechanismus. Dark-Variante wird aus der Light-Datei über den markierten THEME-Variablenblock generiert — Wartungsweg in docs/development.md dokumentiert. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent d678132 commit 87d1273

4 files changed

Lines changed: 783 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77
[![License](https://img.shields.io/badge/license-MPL--2.0-blue)](LICENSE)
88
[![PostgreSQL](https://img.shields.io/badge/PostgreSQL-18-336791)](https://www.postgresql.org)
99

10+
<p align="center">
11+
<picture>
12+
<source media="(prefers-color-scheme: dark)" srcset="docs/how-ctx-works-dark.svg">
13+
<img alt="How ctx works — four access paths into one Go daemon; the store pipeline with time-anchor extraction, embedding and Guard dedup; the query pipeline with temporal parsing, 4-way RRF fusion, temporal gravity, graph expansion and LLM synthesis; and the autonomous Dream Mode loop that cross-links the corpus" src="docs/how-ctx-works.svg" width="100%">
14+
</picture>
15+
</p>
16+
1017
## What it does
1118

1219
ctx gives your LLM a persistent, searchable memory. Store knowledge blocks, query them with hybrid retrieval (semantic + bilingual fulltext + trigram), then rerank with multi-dimensional cyclic gravity — each temporal cycle (weekday, month, quarter, week, monthday, seasonal, daily) scored as its own Gaussian field. Queries like "immer dienstags" or "Weihnachten" activate specific dimensions.

docs/development.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ Retries are declared infrastructure protection (CI `1`, local `0`), not a flake
105105

106106
**Runtime budgets** (`.github/e2e-budget.json`, calibrated) split the e2e wall time (from `report.json`) from the whole-job wall; over budget annotates, `> 10 min` fails the job. **Three consecutive runs over the e2e part budget trigger sharding** — the blob-reporter foundation is already laid, so activation is a documented YAML diff in `ci.yml` (`vars.E2E_SHARD`), currently dormant (measured e2e ≈ 77 s ≪ the trigger). Nightly, a dedicated `web-trend` job writes one duration+flaky JSON trend line per run (`e2e-trend.sh`, retention 90 d) and measures the cumulative `__screenshots__` git-history blob volume (`history-budget.sh`): it annotates from 60 MB and flags the documented escalation path (baseline orphan branch / Git-LFS) from 150 MB, but never auto-fails — that decision is taken with the measurement, not by the CI run.
107107

108+
## README infographic (docs/how-ctx-works*.svg)
109+
110+
The README architecture infographic is a hand-authored animated SVG in two theme variants, selected by GitHub's `<picture>` / `prefers-color-scheme` mechanism. **Edit only `docs/how-ctx-works.svg`** — all colors live in CSS custom properties inside the `/* THEME-START */ … /* THEME-END */` block, and `docs/how-ctx-works-dark.svg` is that same file with only this block swapped. To regenerate the dark variant after an edit, replace the theme block with the dark palette (GitHub dark colors: bg `#0d1117`, panel `#161b22`, accents `#3fb950`/`#58a6ff`/`#a371f7`/`#d29922`/`#f85149`) and keep everything else byte-identical — a `re.sub` over the marker block, never a hand-edit of both files. Icons are emoji (system font stack incl. Noto/Apple/Segoe emoji), arrow flow is a CSS `stroke-dashoffset` animation with a `prefers-reduced-motion` off-switch. Verify rendering with headless Chromium (`chromium --headless --screenshot=… --window-size=1200,2170 <url>`) — serve the file over HTTP, `file://` is blocked in some tools.
111+
108112
## Git hooks
109113

110114
Enable with `git config core.hooksPath .hooks`:

0 commit comments

Comments
 (0)