Ersetze Docusaurus vollständig durch Nuxt-Content-Docs-App
All checks were successful
Build and Push Docker Images / verify-docs-sync (push) Successful in 9s
Build and Push Docker Images / build-backend (push) Successful in 14s
Build and Push Docker Images / build-frontend (push) Successful in 13s
Build and Push Docker Images / build-docs (push) Successful in 1m47s

This commit is contained in:
2026-04-22 18:16:00 +02:00
parent d704e343fc
commit 8c458f4953
28 changed files with 837 additions and 233 deletions

View File

@@ -1,12 +1,6 @@
# FEDEO Docs Site (Docusaurus)
# FEDEO Docs Site (Nuxt Content)
Diese Docusaurus-App rendert die versionierte FEDEO-Dokumentation aus dem Ordner `../docs`.
## Zielpfad in Produktion
Die Seite ist für den Betrieb hinter Traefik unter folgendem Pfad konfiguriert:
- `https://app.fedeo.de/docs`
Diese Docs-App basiert auf Nuxt Content und rendert die Inhalte aus dem Repository-Ordner `docs/`.
## Lokale Entwicklung
@@ -14,46 +8,27 @@ Im Ordner `docs-site` ausführen:
```bash
npm install
npm run start
npm run dev
```
Danach ist die Seite unter `http://localhost:3005` erreichbar.
Die App ist danach unter `http://localhost:3005` erreichbar.
## Statischer Build
## Build
```bash
npm run build
npm run serve
```
## Deploy über Haupt-Compose
## Production-Deploy
Die Docs sind in der zentralen `docker-compose.yml` als eigener Service `docs` eingebunden.
Das Docker-Image startet einen Node-Server auf Port `3000`.
In der Haupt-`docker-compose.yml` wird die App hinter Traefik unter `/docs` veröffentlicht.
Deploy aus dem Projekt-Root:
## Content-Quelle
```bash
docker compose pull docs
docker compose up -d docs
```
Vor `dev` und `build` wird automatisch synchronisiert:
Für ein komplettes Update des gesamten Stacks:
- Quelle: `../docs/**/*.md`
- Ziel: `docs-site/content`
```bash
docker compose pull
docker compose up -d
```
## Workflow bei Funktionsänderungen
Vor jedem Docs-Deploy:
1. Technische Kataloge aktualisieren
```bash
node docs/scripts/sync-funktionsdoku.mjs
```
2. Änderungen committen
3. CI baut und pusht das `docs`-Image
4. Server zieht neues Image und startet den Service neu
Dabei wird `docs/README.md` zu `content/index.md` gemappt.