Neuaufbau: Inhalte bis auf Einstieg entfernt, Startseite/Sidebar/Regeln bereinigt
Deploy tibi-docs / build-and-deploy (push) Failing after 24s
Deploy tibi-docs / build-and-deploy (push) Failing after 24s
This commit is contained in:
1 parent
09a65ab1d7
commit
06c836337f
56 files changed
+22
-16942
No files matched your search
@@ -8,21 +8,24 @@ Regeln für alle Agenten, die an dieser Doku oder an Tibi-Server / Tibi-Admin-No
|
||||
- **Definition of Done:** Jede PR an `tibi-server` oder `tibi-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)
|
||||
## 2. Wo was hingehört (Diátaxis) — Stand: Neuaufbau
|
||||
|
||||
Aktuell existiert nur `einstieg/`. Weitere Bereiche werden sauber neu aufgebaut;
|
||||
pro Bereich Seite anlegen, Sidebar-Gruppe in `astro.config.mjs` ergänzen.
|
||||
|
||||
| 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 |
|
||||
| `server/` (geplant) | **SYNC — nicht von Hand editieren**, Quelle `../tibi-server/docs/` | Collections, Hooks |
|
||||
| `nova/` (geplant) | Teils SYNC aus `../tibi-admin-nova/docs/`, plus Konzeptseite | Sammlungen, Export |
|
||||
| `anwender/` (geplant) | Redakteurs-Anleitungen (Aufgaben, keine Konzepte) | Anmelden, Pflegen |
|
||||
| `reference/` (geplant) | **Generiert — nie von Hand**, OpenAPI/Typen/Schema | openapi.md |
|
||||
| `adr/` (geplant) | Architektur-Entscheide, Format siehe Vorlage im Git-Verlauf (`adr/0000-vorlage.md`) | Starlight-Entscheid |
|
||||
|
||||
## 3. Neue Seite anlegen
|
||||
|
||||
- Datei `src/content/docs/<bereich>/<slug>.md` mit Frontmatter `title` + `description`.
|
||||
- Sidebar: `einstieg`/`anwender` explizit in `astro.config.mjs`, `server`/`nova`/`reference`/`adr` per `autogenerate` (kein Config-Eintrag nötig).
|
||||
- Sidebar: jede Gruppe explizit in `astro.config.mjs` eintragen (beim Neuaufbau pro Bereich ergänzen; `autogenerate` erst nutzen, sobald der Ordner gepflegt befüllt ist).
|
||||
- Bilder nach `src/assets/`, max. 200 KB, deutsche Alt-Texte.
|
||||
|
||||
## 4. Sync-Workflow
|
||||
@@ -33,7 +36,7 @@ npm run sync
|
||||
npm run build # muss fehlerfrei durchlaufen
|
||||
```
|
||||
|
||||
- `server/uebersicht.md` und `nova/konzept.md` sind Handarbeit und werden vom Sync nie überschrieben (`keep`).
|
||||
- `server/uebersicht.md` und `nova/konzept.md` sind Handarbeit und werden vom Sync nie überschrieben (`keep`) — beim Neuaufbau zuerst diese beiden Seiten neu anlegen, dann syncen.
|
||||
- Sync-Artefakte werden mitcommittet (statischer Build braucht sie).
|
||||
|
||||
## 5. Verbote
|
||||
|
||||
Reference in new issue
Block a user