47 lines
1.4 KiB
Markdown
47 lines
1.4 KiB
Markdown
# Tibi Doku
|
|
|
|
Entwickler- und später Anwender-Dokumentation für **Tibi-Server** und **Tibi-Admin-Nova**.
|
|
Basis: [Astro Starlight](https://starlight.astro.build/) — Markdown-Quellen, statischer Build, eingebaute Volltextsuche (Pagefind). Theme an Nova angelehnt (Inter, Near-Black, Nova-Orange).
|
|
|
|
Altes Demo+Docs-Repo liegt archiviert unter `cms/tibi-docs-legacy`.
|
|
|
|
## Start
|
|
|
|
```sh
|
|
npm install
|
|
npm run dev # http://localhost:4321
|
|
# oder
|
|
make docker-up # https://tibi-docs.code.testversion.online/
|
|
make docker-down
|
|
```
|
|
|
|
## Docs pflegen
|
|
|
|
Single Source bleibt in den Quell-Repos — hier wird nur gerendert:
|
|
|
|
```sh
|
|
npm run sync # tibi-server/docs + tibi-admin-nova/docs übernehmen
|
|
npm run sync:openapi # OpenAPI vom laufenden Server holen (TIBI_API_URL)
|
|
npm run build # prüfen, ob alles rendert
|
|
```
|
|
|
|
Eigene Seiten: `src/content/docs/{einstieg,nova,anwender,reference,adr}/`.
|
|
|
|
## Struktur
|
|
|
|
```text
|
|
src/content/docs/
|
|
index.mdx Startseite (Hero)
|
|
einstieg/ was-ist-tibi, schnellstart, begriffe
|
|
server/ SYNC aus tibi-server/docs (nicht von Hand editieren)
|
|
nova/ SYNC aus tibi-admin-nova/docs (+ konzept.md)
|
|
anwender/ Platzhalter Redakteurs-Doku
|
|
reference/ generiert (openapi), nicht von Hand
|
|
adr/ Architektur-Entscheide
|
|
scripts/
|
|
sync-server-docs.mjs
|
|
sync-openapi.mjs
|
|
```
|
|
|
|
Siehe `AGENTS.md` für die Agenten-Regeln.
|