VidArch Docs
Entwickler

Dokumentation pflegen

Diese Website ändern, ohne die Produktanweisungen zu desynchronisieren.

Die Dokumentation befindet sich in einem separaten Repository vom Produkt, damit sie unabhängig veröffentlicht werden kann. Ihr Inhalt muss jedoch mit README.md, .env.example, docker-compose.yml, SECURITY.md und dem VidArch-Code abgestimmt bleiben.

Lokal

npm ci
npm run dev

Der Standardport ist 2499. Definieren Sie VIDARCH_DOCS_PORT, falls VidArch diesen Port bereits verwendet. Die Option npm run dev -- --lan ist für freiwillige Tests im lokalen Netzwerk vorgesehen.

Vor der Auslieferung

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

Die Beispiele müssen fiktive Domains verwenden, keine Geheimnisse enthalten und destruktive Operationen klar kennzeichnen. Jede neue Seite muss im meta.json ihres Abschnitts hinzugefügt werden.

Auf dieser Seite