Files
FEDEO/docs-site

FEDEO Docs Site (Docusaurus)

Diese Docusaurus-App rendert die versionierte FEDEO-Dokumentation aus dem Ordner ../docs.

Lokale Entwicklung

Im Ordner docs-site ausführen:

npm install
npm run start

Danach ist die Seite unter http://localhost:3005 erreichbar.

Statischer Build

npm run build
npm run serve

Deploy mit Docker Compose

Aus dem Projekt-Root:

docker compose -f docker-compose.docs.yml up -d --build

Standard-Port ist 3205.

Workflow bei Funktionsänderungen

Vor jedem Docs-Deploy:

  1. Technische Kataloge aktualisieren
node docs/scripts/sync-funktionsdoku.mjs
  1. Änderungen committen
  2. Docs-Container neu bauen und starten

Wichtige Platzhalter

Bitte in docs-site/docusaurus.config.ts anpassen:

  • url auf die echte Docs-Domain
  • GitHub-Links (editUrl, Repository)