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>
This commit is contained in:
flemming-it
parent
3a7d0e74ad
commit
3b07d340d5
16 changed files with 1051 additions and 3 deletions
|
|
@ -20,6 +20,19 @@
|
|||
"welcomeTrustAuditBody": "Flow-Läufe, Installationen, Deinstallationen, Freigabe-Entscheidungen — alles wird in ein hash-verkettetes Audit-Log geschrieben. Die Diagnose-Seite verifiziert die Kette bei jedem Laden komplett.",
|
||||
"welcomeTrustAirgapTitle": "Air-Gap-tauglich",
|
||||
"welcomeTrustAirgapBody": "Der gesamte Hub steckt in einem einzigen Binary für Linux, macOS und Windows. Sobald ein Modul installiert ist, läuft der Flow, der es nutzt, ohne weiteren Netzwerkzugriff — ideal für regulierte Umgebungen.",
|
||||
"welcomeDocsHeader": "DOKUMENTATION",
|
||||
"welcomeDocsBody": "Operator-Erklärungen, inline gerendert. Kein Browser, kein externer Link — air-gap-tauglich.",
|
||||
"welcomeDocArchitectureTitle": "Architektur in einem Absatz",
|
||||
"welcomeDocArchitectureBlurb": "Hub, Modul, Flow — und wie die drei zusammenpassen.",
|
||||
"welcomeDocSecurityTitle": "Sandbox-Modell",
|
||||
"welcomeDocSecurityBlurb": "Was ein Modul deklariert, was der Operator deckelt, was der Hub durchsetzt.",
|
||||
"welcomeDocAuditTitle": "Manipulationssicheres Audit-Log",
|
||||
"welcomeDocAuditBlurb": "Wie die Hash-Kette funktioniert und warum WORM-1 für KRITIS reicht.",
|
||||
"welcomeDocFlowsTitle": "Flow-Komposition",
|
||||
"welcomeDocFlowsBlurb": "YAML-Grundlagen, Templating-Referenz, das Extract→Summarize-Beispiel.",
|
||||
"welcomeDocClose": "Schließen",
|
||||
"welcomeDocFailedToLoad": "Doku konnte nicht geladen werden: {error}",
|
||||
"@welcomeDocFailedToLoad": { "placeholders": { "error": { "type": "String" } } },
|
||||
"navDoctor": "Diagnose",
|
||||
"navModules": "Module",
|
||||
"navStore": "Store",
|
||||
|
|
|
|||
|
|
@ -21,6 +21,19 @@
|
|||
"welcomeTrustAuditBody": "Flow runs, install / uninstall actions, approval decisions — all of them write into a hash-chained audit log. The Doctor page verifies the chain end-to-end on every load.",
|
||||
"welcomeTrustAirgapTitle": "Air-gap ready",
|
||||
"welcomeTrustAirgapBody": "The whole hub fits in a single binary that runs on Linux, macOS and Windows. Once a module is installed, the flow it powers runs without further network access — perfect for regulated environments.",
|
||||
"welcomeDocsHeader": "DOCUMENTATION",
|
||||
"welcomeDocsBody": "Operator-facing explainers, rendered inline. No browser, no external link — air-gap-friendly.",
|
||||
"welcomeDocArchitectureTitle": "Architecture in one paragraph",
|
||||
"welcomeDocArchitectureBlurb": "Hub, Module, Flow — and how the three fit together.",
|
||||
"welcomeDocSecurityTitle": "Sandbox model",
|
||||
"welcomeDocSecurityBlurb": "What a module declares, what the operator caps, what the hub enforces.",
|
||||
"welcomeDocAuditTitle": "Tamper-evident audit log",
|
||||
"welcomeDocAuditBlurb": "How the hash chain works and why WORM-1 is enough for KRITIS.",
|
||||
"welcomeDocFlowsTitle": "Flow composition",
|
||||
"welcomeDocFlowsBlurb": "YAML basics, templating reference, the extract→summarize example.",
|
||||
"welcomeDocClose": "Close",
|
||||
"welcomeDocFailedToLoad": "Could not load documentation: {error}",
|
||||
"@welcomeDocFailedToLoad": { "placeholders": { "error": { "type": "String" } } },
|
||||
"navDoctor": "Doctor",
|
||||
"navModules": "Modules",
|
||||
"navStore": "Store",
|
||||
|
|
|
|||
|
|
@ -206,6 +206,78 @@ abstract class AppLocalizations {
|
|||
/// **'The whole hub fits in a single binary that runs on Linux, macOS and Windows. Once a module is installed, the flow it powers runs without further network access — perfect for regulated environments.'**
|
||||
String get welcomeTrustAirgapBody;
|
||||
|
||||
/// No description provided for @welcomeDocsHeader.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'DOCUMENTATION'**
|
||||
String get welcomeDocsHeader;
|
||||
|
||||
/// No description provided for @welcomeDocsBody.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Operator-facing explainers, rendered inline. No browser, no external link — air-gap-friendly.'**
|
||||
String get welcomeDocsBody;
|
||||
|
||||
/// No description provided for @welcomeDocArchitectureTitle.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Architecture in one paragraph'**
|
||||
String get welcomeDocArchitectureTitle;
|
||||
|
||||
/// No description provided for @welcomeDocArchitectureBlurb.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Hub, Module, Flow — and how the three fit together.'**
|
||||
String get welcomeDocArchitectureBlurb;
|
||||
|
||||
/// No description provided for @welcomeDocSecurityTitle.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Sandbox model'**
|
||||
String get welcomeDocSecurityTitle;
|
||||
|
||||
/// No description provided for @welcomeDocSecurityBlurb.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'What a module declares, what the operator caps, what the hub enforces.'**
|
||||
String get welcomeDocSecurityBlurb;
|
||||
|
||||
/// No description provided for @welcomeDocAuditTitle.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Tamper-evident audit log'**
|
||||
String get welcomeDocAuditTitle;
|
||||
|
||||
/// No description provided for @welcomeDocAuditBlurb.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'How the hash chain works and why WORM-1 is enough for KRITIS.'**
|
||||
String get welcomeDocAuditBlurb;
|
||||
|
||||
/// No description provided for @welcomeDocFlowsTitle.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Flow composition'**
|
||||
String get welcomeDocFlowsTitle;
|
||||
|
||||
/// No description provided for @welcomeDocFlowsBlurb.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'YAML basics, templating reference, the extract→summarize example.'**
|
||||
String get welcomeDocFlowsBlurb;
|
||||
|
||||
/// No description provided for @welcomeDocClose.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Close'**
|
||||
String get welcomeDocClose;
|
||||
|
||||
/// No description provided for @welcomeDocFailedToLoad.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
/// **'Could not load documentation: {error}'**
|
||||
String welcomeDocFailedToLoad(String error);
|
||||
|
||||
/// No description provided for @navDoctor.
|
||||
///
|
||||
/// In en, this message translates to:
|
||||
|
|
|
|||
|
|
@ -69,6 +69,49 @@ class AppLocalizationsDe extends AppLocalizations {
|
|||
String get welcomeTrustAirgapBody =>
|
||||
'Der gesamte Hub steckt in einem einzigen Binary für Linux, macOS und Windows. Sobald ein Modul installiert ist, läuft der Flow, der es nutzt, ohne weiteren Netzwerkzugriff — ideal für regulierte Umgebungen.';
|
||||
|
||||
@override
|
||||
String get welcomeDocsHeader => 'DOKUMENTATION';
|
||||
|
||||
@override
|
||||
String get welcomeDocsBody =>
|
||||
'Operator-Erklärungen, inline gerendert. Kein Browser, kein externer Link — air-gap-tauglich.';
|
||||
|
||||
@override
|
||||
String get welcomeDocArchitectureTitle => 'Architektur in einem Absatz';
|
||||
|
||||
@override
|
||||
String get welcomeDocArchitectureBlurb =>
|
||||
'Hub, Modul, Flow — und wie die drei zusammenpassen.';
|
||||
|
||||
@override
|
||||
String get welcomeDocSecurityTitle => 'Sandbox-Modell';
|
||||
|
||||
@override
|
||||
String get welcomeDocSecurityBlurb =>
|
||||
'Was ein Modul deklariert, was der Operator deckelt, was der Hub durchsetzt.';
|
||||
|
||||
@override
|
||||
String get welcomeDocAuditTitle => 'Manipulationssicheres Audit-Log';
|
||||
|
||||
@override
|
||||
String get welcomeDocAuditBlurb =>
|
||||
'Wie die Hash-Kette funktioniert und warum WORM-1 für KRITIS reicht.';
|
||||
|
||||
@override
|
||||
String get welcomeDocFlowsTitle => 'Flow-Komposition';
|
||||
|
||||
@override
|
||||
String get welcomeDocFlowsBlurb =>
|
||||
'YAML-Grundlagen, Templating-Referenz, das Extract→Summarize-Beispiel.';
|
||||
|
||||
@override
|
||||
String get welcomeDocClose => 'Schließen';
|
||||
|
||||
@override
|
||||
String welcomeDocFailedToLoad(String error) {
|
||||
return 'Doku konnte nicht geladen werden: $error';
|
||||
}
|
||||
|
||||
@override
|
||||
String get navDoctor => 'Diagnose';
|
||||
|
||||
|
|
|
|||
|
|
@ -69,6 +69,49 @@ class AppLocalizationsEn extends AppLocalizations {
|
|||
String get welcomeTrustAirgapBody =>
|
||||
'The whole hub fits in a single binary that runs on Linux, macOS and Windows. Once a module is installed, the flow it powers runs without further network access — perfect for regulated environments.';
|
||||
|
||||
@override
|
||||
String get welcomeDocsHeader => 'DOCUMENTATION';
|
||||
|
||||
@override
|
||||
String get welcomeDocsBody =>
|
||||
'Operator-facing explainers, rendered inline. No browser, no external link — air-gap-friendly.';
|
||||
|
||||
@override
|
||||
String get welcomeDocArchitectureTitle => 'Architecture in one paragraph';
|
||||
|
||||
@override
|
||||
String get welcomeDocArchitectureBlurb =>
|
||||
'Hub, Module, Flow — and how the three fit together.';
|
||||
|
||||
@override
|
||||
String get welcomeDocSecurityTitle => 'Sandbox model';
|
||||
|
||||
@override
|
||||
String get welcomeDocSecurityBlurb =>
|
||||
'What a module declares, what the operator caps, what the hub enforces.';
|
||||
|
||||
@override
|
||||
String get welcomeDocAuditTitle => 'Tamper-evident audit log';
|
||||
|
||||
@override
|
||||
String get welcomeDocAuditBlurb =>
|
||||
'How the hash chain works and why WORM-1 is enough for KRITIS.';
|
||||
|
||||
@override
|
||||
String get welcomeDocFlowsTitle => 'Flow composition';
|
||||
|
||||
@override
|
||||
String get welcomeDocFlowsBlurb =>
|
||||
'YAML basics, templating reference, the extract→summarize example.';
|
||||
|
||||
@override
|
||||
String get welcomeDocClose => 'Close';
|
||||
|
||||
@override
|
||||
String welcomeDocFailedToLoad(String error) {
|
||||
return 'Could not load documentation: $error';
|
||||
}
|
||||
|
||||
@override
|
||||
String get navDoctor => 'Doctor';
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue