chain-studio/assets/docs/architecture_de.md
flemming-it 3b07d340d5 feat(studio): Welcome page Phase B — embedded doc reader (v0.38.0)
Second slice of the Welcome surface. Operator-facing
documentation now lives inside Studio as bundled assets and
renders inline via a modal sheet — no browser, no external
link, air-gap-tauglich.

- Four operator-readable explainers under `assets/docs/`,
  each with an EN + DE pair:
    architecture[_de].md  — Hub / Module / Flow + how they fit
    security[_de].md       — sandbox model, declared perms,
                              operator ceiling
    audit[_de].md          — hash-chained log, WORM-1 mechanics,
                              `fai admin verify-events`
    flows[_de].md          — flow YAML, templating reference,
                              extract→summarize example
  These are short (≈ 300-500 words each), operator-shaped
  prose. Not copies of the architecture docs in
  fai_platform/docs/architecture/ — those are
  contributor-dense.

- pubspec.yaml declares `assets/docs/` so the markdown ships
  inside the Studio binary. Air-gap deployments read them
  with no network access.

- New `_DocReaderSheet` modal: 85 %-of-viewport bottom sheet,
  drag handle + title bar with the doc icon and close button,
  scrollable Markdown body styled to match Studio chrome.
  Loads `assets/docs/<slug>_<locale>.md` first, falls back to
  the EN file. Locale comes from
  `Localizations.localeOf(context)`.

- `_DocsRow` on the Welcome page sits below the trust-posture
  deck. Two-column grid on ≥ 640 dp, single column below.
  Each card is icon + title + one-line blurb + chevron;
  click opens the reader sheet for that slug.

- 12 new ARB keys for the docs section (header, blurb, four
  card titles + blurbs, close button, error message).
- 4 new icons reused: `account_tree_outlined` (architecture),
  `shield_outlined` (security), `verified_outlined` (audit),
  `alt_route_outlined` (flows).

Implements Phase B of `docs/landing-page-design.md`. Phase C
(live getting-started checklist with persistent state) is the
last remaining slice.

Signed-off-by: flemming-it <stefan.a.flemming@googlemail.com>
2026-05-09 00:24:31 +02:00

55 lines
2.2 KiB
Markdown

# Architektur in einem Absatz
F∆I hat drei Konzepte, die dir überall begegnen: **Hub**,
**Modul**, **Flow**.
**Der Hub** ist ein einzelnes Rust-Binary namens `fai`. Er
läuft als gRPC-Server, lädt Module, führt Flows aus und
schreibt Ereignisse in eine SQLite-Datenbank. Ein Binary, kein
Docker, kein Message-Broker, kein Cluster. Du kannst ihn auf
einem Laptop, einem Raspberry Pi oder einem abgeriegelten
KRITIS-Server laufen lassen — immer dasselbe Artefakt.
**Ein Modul** ist eine kleine WebAssembly-Komponente, die eine
Sache gut macht. Module laufen in einer Sandbox: jedes deklariert
die Netzwerk-Endpunkte, Dateien und Umgebungsvariablen, die es
braucht, und der Hub setzt diese Liste durch. Ein Modul, das
keinen Netzwerkzugriff anfordert, kann das Netzwerk nicht
erreichen. Module kommen als `.fai`-Bundles mit CycloneDX-SBOM
und sigstore-Signatur.
**Ein Flow** ist eine YAML-Datei mit drei Top-Level-Schlüsseln:
`inputs:`, `steps:`, `outputs:`. Schritte laufen in deklarierter
Reihenfolge, jeder Schritt ruft ein Modul auf, und Ausgaben
eines Schritts können in die Eingaben des nächsten fließen.
Flows sind deterministisch — gleiche Eingaben erzeugen dieselbe
Audit-Spur.
## Wie die Teile zusammenpassen
```
Studio ──gRPC──▶ Hub ──lädt──▶ Modul (WASM)
├──führt aus──▶ Flow (YAML-Verkettung von Modulen)
└──schreibt────▶ Audit-Log (hash-verkettet, in
SQLite; WORM-1 qua Konstruktion)
```
## Was du nicht brauchst
- Keine Container-Runtime. Der Hub ruft kein Docker oder Podman.
Module sind WASM-Komponenten, in-process geladen.
- Keine externe Datenbank. SQLite kommt mit dem Hub.
- Keine Hintergrunddienste. Ein Prozess; Neustart per
`fai daemon restart` — siehe Diagnose → Daemon-Steuerung.
## Wo es in dieser App weitergeht
- **Store** zum Entdecken von Modulen und föderierten MCP/n8n-
Fähigkeiten, Installation in einem Klick.
- **Flows** zum Ausführen der Beispiel-Flows, die mit dem Hub
kommen (z.B. `extract-summarize`).
- **Protokoll** für jedes vom Hub aufgezeichnete Ereignis — das
hash-verkettete Log ist die Single Source of Truth der
Plattform.