Improve Tibi docs coverage and screenshot placement

This commit is contained in:
apairon committed 2026-10-18 09:36:37 +00:00
1 parent 7409bc2406
commit 15c1976c60
23 files changed
+417 -351

No files matched your search

+1 -1
View File
@@ -120,4 +120,4 @@ Klick-Abläufe dazu stehen im Test-Plan `docs/test-plans/40-actions.md` (Methode
Anwender-Sicht zum Starten einer Aktion: [Aktionen ausführen](/anwender/aktionen/).
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); `execution`-Abschnitt verifiziert am 4c55f82 (tibi-types: action.schema.json:274-288, 401-403), am 2b091d8 (ActionView.svelte:260-295, 350-382)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); `execution`-Abschnitt verifiziert am 4c55f82 (tibi-types: action.schema.json:274-288, 401-403), am 2b091d8 (ActionView.svelte:260-295, 350-382); Screenshot-Mock verifiziert am bff84be6 2026-10-17 (tibi-admin-nova: corporate/actions/reindex-search.yml)
+2 -2
View File
@@ -67,6 +67,8 @@ Manche Sammlungen haben Reiter über der Liste (`meta.subNavigation`, z. B. `?su
</TabItem>
</Tabs>
![Seitenliste im tibi-admin: geöffneter Filter mit Feld-Filtern, Mikrofon-Symbol im fokussierten Seitentitel-Feld und Paginierung in der Fußzeile](../../../assets/admin/admin-filter-voice.webp)
## Mehrfachauswahl und Tastatur
- Auswahl per Checkbox, `Leertaste` oder `a` (alle umschalten). Pfeiltasten bewegen den Fokus, `Enter` öffnet den Eintrag.
@@ -101,8 +103,6 @@ Teile eine gefilterte Liste per URL — Empfänger sehen exakt dieselbe Auswahl,
| Gesamtzahl fehlt oder lädt lange | `/_count` auf altem Server nicht verfügbar | Direkt laden lassen (Fallback) oder Server aktualisieren |
| Ansicht startet „falsch“ | `viewHint` der Sammlung schlägt die Startansicht vor | Ansicht einmal wechseln — `view=…` in der URL gewinnt |
![Seitenliste im tibi-admin: geöffneter Filter mit Feld-Filtern, Mikrofon-Symbol im fokussierten Seitentitel-Feld und Paginierung in der Fußzeile](../../../assets/admin/admin-filter-voice.webp)
Anwender-Sicht zum Ändern vieler Einträge auf einmal: [Massenbearbeitung](/anwender/massenbearbeitung/).
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova)
+2 -2
View File
@@ -51,6 +51,8 @@ Der Org-Drawer zeigt **Einstellungen** (**Name**, **Branche**, **Ort**, **Websit
</Steps>
![Benutzerverwaltung im tibi-admin: Benutzerliste mit Rollen-Badges und Team-Chips, rechts der geöffnete Detail-Drawer mit Rollenauswahl und Organisations-Zuordnung](../../../assets/admin/admin-benutzer-rechte.webp)
## Rollen und Chips
<Badge text="role: 0" variant="tip" /> <Badge text="role: 1" variant="note" />
@@ -151,8 +153,6 @@ Stellvertretung nur mit Freigabe nutzen — du handelst mit den Rechten der vert
| Token-Bereich leer | Server ohne Token-Feature (`404`) | Normal — kein Fehler, Bereich bleibt verborgen |
| `permission denied` | Kopf oder Recht falsch | [Token-Köpfe](/reference/token-koepfe/) und Chips prüfen |
![Benutzerverwaltung im tibi-admin: Benutzerliste mit Rollen-Badges und Team-Chips, rechts der geöffnete Detail-Drawer mit Rollenauswahl und Organisations-Zuordnung](../../../assets/admin/admin-benutzer-rechte.webp)
Klick-Abläufe zur Stellvertretung stehen im Test-Plan `docs/test-plans/42-impersonation.md` (Auslöser, Bestätigungsdialog, Banner, Rückkehr zur Admin-Sitzung — nur im Mock-Modus testen).
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); Projekt-Admin-Token verifiziert am 4c55f82 (tibi-types: project.schema.json:227-261), am 68b4278 (tibi-server: models/project.go:116-120)
+3 -3
View File
@@ -71,11 +71,11 @@ Volle Kontext-Tabelle in der Repo-Doku `custom-export-script.md`; Bedienung unte
</TabItem>
</Tabs>
![Angepasste Listenansicht im tibi-admin: Seitenliste mit Filter-Reitern und geöffnetem Export-Dialog mit den eigenen Export-Reitern Seiten-Report und Seiten-CSV](../../../assets/admin/admin-customizing.webp)
<Aside type="caution">
Anpassungen an Sammlungs-Config und Skripten erst im lokalen Stack ([einrichten](/admin/setup/)) testen — falsche `meta`-Einträge blenden Ansichten oder Export-Reiter ersatzlos aus.
</Aside>
![Angepasste Listenansicht im tibi-admin: Seitenliste mit Filter-Reitern und geöffnetem Export-Dialog mit den eigenen Export-Reitern Seiten-Report und Seiten-CSV](../../../assets/admin/admin-customizing.webp)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); Widerspruchsprüfung am 2026-10-17: veraltete `meta.views`-Zeile parallel zu `meta.viewHint` korrigiert, kein Custom-Views-Widerspruch mehr.
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); Screenshot-Mock verifiziert am bff84be6 2026-10-17 (tibi-admin-nova: corporate/collections/pages.yml); Widerspruchsprüfung am 2026-10-17: veraltete `meta.views`-Zeile parallel zu `meta.viewHint` korrigiert, kein Custom-Views-Widerspruch mehr.
+2 -2
View File
@@ -75,6 +75,8 @@ Sprachwechsel-Tastenkürzel: `Strg + L` (zyklisch durch die Inhaltssprachen).
Seitenfelder (`pagebuilder`) rendert `PagebuilderWidget` als Stapel aus Block-Karten mit Block-Label und Farbpunkt. Ein Klick öffnet den Overlay-Editor (`PagebuilderOverlay`): links das Formular, rechts die Live-Vorschau, oben der Modus-Umschalter (**Nur Formular**, **Formular und Vorschau**, **Nur Vorschau**) und **OK** (oder `Esc`) zum Schließen. Das Übersichts-Overlay (`PagebuilderOverviewOverlay`, Knopf **Pagebuilder-Overlay öffnen**) listet alle Blöcke als Blueprint-Karten (`BlueprintCard`: Typ, Bilder, Kind-Elemente, weitere Felder) zum Anspringen und Umsortieren. Unter der Vorschau steuert `PagebuilderViewportControl` die simulierte Breite: **Desktop** (1280), **Tablet** (768), **Mobil** (375), per Slider frei von 320 bis 1920 px. Blöcke anlegen und füllen steht unter [Seiten bauen](/anwender/seiten-bauen/).
![Eintrags-Editor im tibi-admin: Pagebuilder-Blöcke im Formular, Übersetzungsleiste mit DE- und EN-Reitern und Seitenleiste mit Einstellungen und Metadaten](../../../assets/admin/admin-eintrags-editor.webp)
## Tastatur
| Kürzel | Wirkung |
@@ -101,6 +103,4 @@ Drücke `?` im Editor — die Hilfe listet alle Kürzel inklusive Listen-Kürzel
| Übersetzung fehlt in der Leiste | Kein Gruppenschlüssel oder Sprache nicht konfiguriert | `translationKey`/`lang` prüfen, fehlende Sprache per `+` anlegen |
| Änderung „verschwunden“ | Drawer geschlossen ohne Speichern | Auf Änderungs-Warnung achten, erst Drawer-, dann Haupt-Speichern |
![Eintrags-Editor im tibi-admin: Pagebuilder-Blöcke im Formular, Übersetzungsleiste mit DE- und EN-Reitern und Seitenleiste mit Einstellungen und Metadaten](../../../assets/admin/admin-eintrags-editor.webp)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova)
+2 -2
View File
@@ -19,6 +19,8 @@ Du exportierst Einträge einer Sammlung im **tibi-admin** (Verwaltungs-Backend,
</Steps>
![Export-Dialog im tibi-admin: Formatwahl zwischen JSON, CSV und XLSX sowie Spaltenliste mit vorausgewählten Feldern](../../../assets/admin/admin-exporte.webp)
| Format | Technik | Wofür |
|---|---|---|
| `JSON` | Rohdatensätze als Datei | Weiterverarbeitung, Sicherung, Import anderswo |
@@ -107,6 +109,4 @@ Details für Entwickler (Styling per `cell.s`, Spaltenbreiten, Autofilter) stehe
| Skript-Fehler im Dialog | Modul ohne Standard-Export oder Laufzeitfehler | Browser-Konsole lesen, Modul-Export und Rückgabeformat prüfen |
| Leere Datei trotz Treffern | Leserecht auf Zielfelder fehlt | Rechte unter [Rechte und Tokens](/projekt/rechte-tokens/) klären |
![Export-Dialog im tibi-admin: Formatwahl zwischen JSON, CSV und XLSX sowie Spaltenliste mit vorausgewählten Feldern](../../../assets/admin/admin-exporte.webp)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); `ctx`-Tabelle und Beispiel verifiziert am 2b091d8 (custom-export.types.ts:17-102, custom-export-script.md, custom-export-result.ts:14-18)
+2 -2
View File
@@ -89,6 +89,8 @@ Verhalten: Quelle zuerst Browser-**„Systemstimme auf diesem Gerät“** (passe
</TabItem>
</Tabs>
![Geöffneter Nova-Chat im tibi-admin: Begrüßungsnachricht, Eingabefeld mit Mikrofon-Knopf und Sammlungsübersicht des Corporate-Projekts dahinter](../../../assets/admin/admin-ki-funktionen.webp)
Zusatz: **Vision** (`/api/ai/vision`) beschreibt Bilder für CMS-Felder („erfinde keine nicht sichtbaren Fakten“); **Übersetzung** (`/api/ai/chat` mit System-Prompt) hält das angeforderte Ausgabeformat exakt ein.
## Werkzeuge
@@ -143,6 +145,4 @@ Wichtig zur Einordnung: Der Admin-Chat läuft über den Proxy (`/api/ai/chat`, `
| **„Transkription fehlgeschlagen: \{error\}“** | Rate-Limit, Netz oder Proxy-Fehler | Kürzeren Abschnitt sprechen, erneut versuchen |
| Stimme klingt falsch | Andere Stimme aktiv | Stimme in den KI-Einstellungen zurück auf `eva-de` setzen |
![Geöffneter Nova-Chat im tibi-admin: Begrüßungsnachricht, Eingabefeld mit Mikrofon-Knopf und Sammlungsübersicht des Corporate-Projekts dahinter](../../../assets/admin/admin-ki-funktionen.webp)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova: AiChat/AiButton/AiConversationList/AiToolStatus/AiToolInspector/AiDebugContext, aiChatHistory/aiController/aiTools/aiTokenEstimator/aiVoiceInput/aiSummarizer/aiTTS/aiModelCatalog, config/ai-proxy.config.json, frontend/assets/system.config.json, de.json admin.ai + Befehle)
+2 -2
View File
@@ -11,9 +11,9 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
- Laufzeitwerte in `frontend/assets/system.config.json`, Proxy-Ziele/Modelle in `config/ai-proxy.config.json`.
- Screens: `frontend/src/lib/components/admin/` (Hub, Orgs, Teams, User, Projekte) und `components/entry/` (Editor, Widgets, Drawers, Preview).
## Schnellsuche und Tastatur
## Befehlspalette und Tastatur
Die **Befehlspalette** öffnest du mit `/` (oder `Strg`/`Cmd` + `K`) — sie springt zu Sammlungen, Einträgen, Aktionen und Verwaltungsseiten, ohne dass du dich durch die Navigation klickst. `?` zeigt alle Tastenkürzel (Vollreferenz: [Tastatur und Schnellsuche](/reference/tastatur-kurzbefehle/)).
Die **Befehlspalette** öffnest du mit `/` (oder `Strg`/`Cmd` + `K`) — sie springt zu Sammlungen, Einträgen, Aktionen und Verwaltungsseiten, ohne dass du dich durch die Navigation klickst. `?` zeigt alle Tastenkürzel (Vollreferenz: [Tastatur und Befehlspalette](/reference/tastatur-kurzbefehle/)).
![Befehlspalette im tibi-admin über Corporate Website: Suchfeld mit dem Hinweis „Befehl eingeben…", Trefferliste mit Navigation, Sammlungen und Aktionen](../../../assets/admin/admin-befehlspalette.webp)
+2 -2
View File
@@ -47,6 +47,8 @@ Den Editor öffnest du aus der Kachel oder aus Datei-Feldern (`Bild bearbeiten`)
Welche Werkzeuge verfügbar sind, steuert die Projekt-Konfiguration (`crop`, `rotate`, `flip`, `scale`, `focalPoint`, `adjust`, `palette`).
![Bildeditor im tibi-admin als Vollbild-Dialog: Werkzeugleiste mit Zuschnitt, Anpassung und Skalierung über dem geöffneten Foto, dahinter das abgedunkelte Medienraster](../../../assets/admin/admin-medien.webp)
## Einbetten
Aus Redakteurs-Sicht gibt es drei Wege, eine Datei in Inhalte zu bringen:
@@ -78,6 +80,4 @@ Bilder im Fließtext verwaltet das `richtext`-Widget des Editors (siehe [Eintrag
| Bild-Einbettung bleibt leer | Verweis ohne `lookup` gelesen oder Eintrag nicht öffentlich | `lookup` auf `medialib` prüfen, `active`-Status und Rechte unter [Rechte und Tokens](/projekt/rechte-tokens/) klären |
| Editor-Änderung weg | Dialog ohne Übernehmen geschlossen | Erst im Bildeditor übernehmen, dann den Eintrag speichern |
![Bildeditor im tibi-admin als Vollbild-Dialog: Werkzeugleiste mit Zuschnitt, Anpassung und Skalierung über dem geöffneten Foto, dahinter das abgedunkelte Medienraster](../../../assets/admin/admin-medien.webp)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova)
+1 -1
View File
@@ -54,4 +54,4 @@ Ein gestarteter Lauf lässt sich nicht abbrechen.
Ein gestarteter Lauf lässt sich nicht abbrechen; ein zweiter Lauf löst Versand und Berechnung erneut aus.
</Aside>
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova)
Verifiziert am 2b091d8 2026-10-17 (tibi-admin-nova); Screenshot-Mock verifiziert am bff84be6 2026-10-17 (tibi-admin-nova: corporate/actions/reindex-search.yml)
+1 -1
View File
@@ -3,7 +3,7 @@ title: Tibi Doku
description: Entwickler- und Anwender-Dokumentation für Tibi-Server und Tibi-Admin.
template: splash
hero:
tagline: Headless-CMS mit Go-Backend und Svelte-Frontends — hier steht, wie man damit baut.
tagline: Headless-CMS mit Go-Backend und Svelte-Frontends — hier steht, wie du damit baust.
actions:
- text: Schnellstart
link: /einstieg/schnellstart/
@@ -1,9 +1,9 @@
---
title: 'Schema-Properties (generiert)'
description: 'Alle Properties aller 16 Config-Schemas als Tabelle — generiert, nicht von Hand editieren.'
description: 'Alle Properties aller 17 Config-Schemas als Tabelle — generiert, nicht von Hand editieren.'
---
Diese Seite listet die Properties aller 16 Config-Schemas aus `tibi-types/schemas/config/`.
Diese Seite listet die Properties aller 17 Config-Schemas aus `tibi-types/schemas/config/`.
> Generiert, nicht von Hand editieren — neu erzeugen mit `npm run gen:schemas`.
@@ -142,6 +142,23 @@ Dieses Schema definiert nur **`$ref`-Bausteine** (kein eigenes Config-Ziel):
| `methodPermissionGet` | boolean oder object | — | — |
| `methodPermissionWrite` | boolean oder object | — | — |
## embedding
*Tibi server config — embedding section (server-level, not project config)* — `embedding.schema.json`
| Property | Typ | Pflicht | Vorgabe/Default | Beschreibung |
| --- | --- | --- | --- | --- |
| `providers` | Liste von `provider` — object | nein | — | — |
| `groups` | Liste von `group` — object | nein | — | — |
| `goldenPath` | string | nein | — | Verzeichnis der Gold-Dateien für die Mitglieds-Prüfung (Vorgabe: testdata/embedding-golden relativ zum Arbeitsverzeichnis). Erzeugen mit cmd/embed-probe-golden. Ohne verankerte Gold-Datei prüft die Gruppe nur gegen ihre Referenz. |
### Bausteine in embedding
| Baustein | Felder | Pflicht |
| --- | --- | --- |
| `provider` | `name`, `type`, `model`, `modelPath`, `dimensions`, `baseURL`, `apiKey`, `documentPrefix`, `queryPrefix`, `timeoutPerAttempt`, `slowThreshold`, `revision`, `sparse` | `name` |
| `group` | `name`, `description`, `members`, `onSingleQuery`, `onBulkWrite`, `health` | `name`, `members` |
## field-list
*Tibi field list config* — `field-list.schema.json`
@@ -383,4 +400,4 @@ Pflicht: `name`.
| `permissions` | Liste von string | nein | — | Bare permission names for team-based access (Phase 2). Empty = admin-only in Phase 1. |
| `enabled` | boolean | nein | `false` | Whether this snapshot profile is active. Disabled profiles are skipped by the scheduler but can still be triggered manually. |
Generiert aus `tibi-types 4c55f82` (Stand 2026-10-12) — Änderungen an den Schemas dort erfordern `npm run gen:schemas`.
Generiert aus `tibi-types 3bf8055` (Stand 2026-10-17) — Änderungen an den Schemas dort erfordern `npm run gen:schemas`.
+3 -2
View File
@@ -9,7 +9,7 @@ Deine `api/*.yml`-Dateien sind durch JSON-Schemas geprüft. Die Schemas liegen i
## Schema-Liste
Das Verzeichnis enthält 16 Dateien (nicht 15, wie ältere Docs behaupten):
Das Verzeichnis enthält 17 Dateien:
| Schema | Gilt für | Pflichtfelder |
| --- | --- | --- |
@@ -29,6 +29,7 @@ Das Verzeichnis enthält 16 Dateien (nicht 15, wie ältere Docs behaupten):
| `snapshot.schema.json` | Snapshots in `config.yml` | `name` |
| `openapi.schema.json` | OpenAPI-Metadaten je Collection | keine |
| `defs.schema.json` | nur `$ref`-Bausteine, kein eigenes Ziel | — |
| `embedding.schema.json` | `embedding:` in der Server-`config.yml` | keine (Provider und Gruppen sind optional) |
## Vollständige Property-Matrix
@@ -91,4 +92,4 @@ tibi-server beim Reload (Bedeutung)
- Schlage einen Hook-Kontext nach: Hook-Kontexte.
- Verstehe Fehlermeldungen: Fehlerbilder.
Verifiziert am 4c55f82 2026-10-12 (tibi-types)
Verifiziert am 3bf8055 2026-10-17 (tibi-types, 17 JSON-Schemas einschließlich embedding.schema.json)
@@ -1,5 +1,5 @@
---
title: 'Tastatur und Schnellsuche'
title: 'Tastatur und Befehlspalette'
description: 'Alle Tastenkürzel, die Befehlspalette und die Breadcrumb-Navigation im tibi-admin.'
---