2.4 KiB
2.4 KiB
AGENTS.md — Tibi Doku
Regeln für alle Agenten, die an dieser Doku oder an Tibi-Server / Tibi-Admin-Nova arbeiten.
1. Grundsatz
- Single Source: Code-Nähe schlägt Doku-Kopie. Details stehen in
tibi-server/docs/bzw.tibi-admin-nova/docs/, diese Seite rendert nur. - Definition of Done: Jede PR an
tibi-serverodertibi-admin-nova, die API, Hooks, Collections, Permissions, Jobs, Realtime, LLM, Deploy oder UX ändert, aktualisiert auch die Docs — sonst ist die PR nicht fertig. - Sprache: Deutsch, saubere Umlaute (ä ö ü ß), Du-Form für Anleitungen, kurze Sätze.
2. Wo was hingehört (Diátaxis)
| Ordner | Inhalt | Beispiel |
|---|---|---|
einstieg/ |
Tutorials, Erste Schritte | Schnellstart, Begriffe |
server/ |
SYNC — nicht von Hand editieren, Quelle ../tibi-server/docs/ |
Collections, Hooks |
nova/ |
Teils SYNC aus ../tibi-admin-nova/docs/, plus konzept.md |
Sammlungen, Export |
anwender/ |
Redakteurs-Anleitungen (Aufgaben, keine Konzepte) | Anmelden, Pflegen |
reference/ |
Generiert — nie von Hand, OpenAPI/Typen/Schema | openapi.md |
adr/ |
Architektur-Entscheide, Format siehe 0000-vorlage.md |
0001-starlight |
3. Neue Seite anlegen
- Datei
src/content/docs/<bereich>/<slug>.mdmit Frontmattertitle+description. - Sidebar:
einstieg/anwenderexplizit inastro.config.mjs,server/nova/reference/adrperautogenerate(kein Config-Eintrag nötig). - Bilder nach
src/assets/, max. 200 KB, deutsche Alt-Texte.
4. Sync-Workflow
# nach jeder Änderung in tibi-server/docs oder tibi-admin-nova/docs:
npm run sync
npm run build # muss fehlerfrei durchlaufen
server/uebersicht.mdundnova/konzept.mdsind Handarbeit und werden vom Sync nie überschrieben (keep).- Sync-Artefakte werden mitcommittet (statischer Build braucht sie).
5. Verbote
- Keine Secrets, Tokens, Kundennamen oder interne Hosts in die Doku.
- Keine englischen Server-Docs duplizieren und übersetzen — lieber verlinken und bei Bedarf eigene deutsche Einstiegsseite.
- Keine toten Links:
npm run buildbricht bei kaputten internen Links — erst fixen, dann pushen.
6. Theming
src/styles/custom.cssist an Nova angelehnt (Inter,--sl-color-accentNear-Black, Nova-Orange#c2410cals Zweitakzent). Farben nur dort ändern, nicht inline.- Logo/Favicon:
src/assets/favicon.svg(Nova-Supernova). Austausch nur gegen offizielles Nachfolge-Logo.