apairon c22b324294
Deploy tibi-docs / build-and-deploy (push) Failing after 33s
docs(tools): document custom tools and add overview screenshot
2026-10-20 20:45:24 +00:00

Tibi Doku

Entwickler- und Anwender-Dokumentation für Tibi-Server und Tibi-Admin (Release Nova). Basis: Astro Starlight — Markdown-Quellen, statischer Build, eingebaute Volltextsuche (Pagefind, läuft komplett im Browser). Theme an Nova angelehnt (Inter, Near-Black, Nova-Orange).

Live: https://docs.tibicms.de — ersetzt die alte Docpress-Doku (cms/tibi-docs-legacy, archiviert).

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:openapi # OpenAPI vom laufenden Server holen (TIBI_API_URL)
npm run gen:schemas  # reference/schema-properties.md aus tibi-types erzeugen
npm run build        # prüfen, ob alles rendert
node scripts/audit-docs.mjs   # Frontmatter, Links, Anker, Bilder, Tabellen (nach dem Build)

Eigene Seiten: src/content/docs/{einstieg,projekt,server,admin,anwender,reference,adr}/.

Deploy

Push auf master löst .gitea/workflows/deploy.yml aus:

  1. npm ci und npm run build (statischer Build nach dist/).
  2. Sanity-Check: dist/index.html, dist/404.html, dist/pagefind/ müssen existieren.
  3. rsync ./dist/ mit --delete auf ftp1.webmakers.de:22223.

Auth läuft über den Repo-Token (github.token), nicht über Passwörter. Die Basispanel-Subdomain docs.tibicms.de (ID 2216, dock4) trägt gitbaseRepository=cms/tibi-docs und deployRoot=./; das rsync-Chroot ist der Docroot der Subdomain, deshalb ist ./ direkt das Webroot. HTTPS kommt per certbot, HTTP wird auf HTTPS umgeleitet.

Zum Vergleich: Projekt-Websites aus tibi-svelte-starter deployen frontend/ und api/ auf dieselbe Art (siehe projekt/deploy in der Doku).

Struktur

src/content/docs/
  index.mdx          Startseite (Hero)
  einstieg/          was-ist-tibi, schnellstart, begriffe, neues-projekt
  projekt/           Sammlungen, Hooks, SSR, Suche, Deploy …
  server/            Konfiguration, Betrieb, Sicherheit, Schnittstellen
  admin/             Bedienoberfläche tibi-admin
  anwender/          Redakteurs-Anleitungen
  reference/         OpenAPI, Schemas, Hook-Kontexte (teils generiert)
  adr/               Architektur-Entscheide
scripts/
  audit-docs.mjs          Prüfung von Quellen und gebautem dist/
  coverage-inventory.mjs  Coverage-Inventar (Routen, Kontexte, Tools, Schemas)
  gen-schema-matrix.mjs   Schema-Properties generieren
  sync-openapi.mjs        OpenAPI vom laufenden Server holen
plans/                     Audit-, Ausbau- und Screenshot-Pläne

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

S
Description
No description provided
Readme
36 MiB
0 Stars 1 Watchers 0 Forks
Languages
MDX 86.8%
JavaScript 11.8%
CSS 1%
Makefile 0.3%