Dokumentationsportal betreiben

Das Dokumentationsportal ist die Astro-Starlight-App apps/docs. Diese Seite beschreibt den lokalen Betrieb und den geplanten Veröffentlichungsweg. Die Domain ist vorgemerkt; ein Live-Betrieb ist damit nicht bestätigt.

Lokal entwickeln

Der Dev-Server von Astro lauscht auf Port 4321.

Aus dem Repository-Root:

npx turbo run dev --filter=docs

Gleichwertig im Paket:

npm run dev --workspace=docs

Erreichbar unter http://localhost:4321. Suche, Sidebar und Markdown-Seiten liegen unter apps/docs/src/content/docs/. Statische Dateien, einschließlich OpenAPI, liegen unter apps/docs/public/ und erscheinen unter demselben Pfad, zum Beispiel /openapi/public-v1.yaml.

Bauen und prüfen

npx turbo run build --filter=docs

Der Task erzeugt apps/docs/dist und führt anschließend node ./scripts/check-docs.mjs aus. Typprüfung:

npx turbo run check-types --filter=docs

Vorschau des Produktionsbuilds:

npm run preview --workspace=docs

Redaktionelle Definition of Done, Same-PR-Pflicht und das E2E-Gate docs-portal stehen in Qualität und Prozess.

Geplante Veröffentlichung (nicht live)

Status: geplant. Die folgenden Werte sind die beabsichtigte Dokploy-Konfiguration. Sie dürfen nicht als bereits erreichbarer Produktivbetrieb gelesen werden. In docs/operations/dokploy.md sind derzeit nur api, web und waitlist als ausgerollte Anwendungen beschrieben.

Feld	Geplanter Wert
Dokploy-Anwendung	docs
Buildpfad	Repository-Root
Publish-Verzeichnis	apps/docs/dist
Domain	docs.orbinaut.ccl-dev.com
Ausgabe	statische Dateien aus dem Docs-Build

Solange die Anwendung docs in Dokploy nicht existiert oder die Domain nicht auf eine erfolgreiche Revision zeigt, ist das Portal nicht öffentlich. Links in der Starlight-Konfiguration (site) und in der OpenAPI-externalDocs benennen die vorgesehene URL; sie belegen keine Erreichbarkeit.

Nach einer späteren Inbetriebnahme wären DNS, TLS, die Startseite, eine tiefe Route (/rest-api/referenz/) und /openapi/public-v1.yaml per HTTPS zu prüfen. Bis dahin bleibt die Prüfung lokal: Port 4321, Turbo-Filter docs, Build nach apps/docs/dist.

Abgrenzung

• web, api und waitlist sind bestehende Dokploy-Anwendungen; docs ist zusätzlich geplant.
• Die öffentliche REST-API bleibt https://api.orbinaut.ccl-dev.com.
• Secrets der API gehören nicht in die Docs-App und nicht in dieses Portal.