Files
tibi-docs/README.md
T
2026-10-16 12:09:43 +00:00

1.2 KiB

Tibi Doku

Entwickler- und später Anwender-Dokumentation für Tibi-Server und Tibi-Admin-Nova. Basis: Astro Starlight — 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

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:

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

src/content/docs/
  index.mdx          Startseite (Hero)
  einstieg/          was-ist-tibi, schnellstart, begriffe
  # Neuaufbau: server/, nova/, anwender/, reference/, adr/ folgen
scripts/
  sync-server-docs.mjs
  sync-openapi.mjs

Siehe AGENTS.md für die Agenten-Regeln.