VidArch Docs
Développeurs

Maintenir la documentation

Modifier ce site sans désynchroniser les instructions du produit.

La documentation vit dans un dépôt séparé du produit afin de pouvoir être publiée indépendamment. Son contenu doit néanmoins rester aligné avec README.md, .env.example, docker-compose.yml, SECURITY.md et le code VidArch.

En local

npm ci
npm run dev

Le port par défaut est 2499. Définissez VIDARCH_DOCS_PORT si VidArch utilise déjà ce port. L'option npm run dev -- --lan est réservée aux tests volontaires sur le réseau local.

Avant livraison

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

Les exemples doivent utiliser des domaines fictifs, ne contenir aucun secret et indiquer clairement les opérations destructives. Toute nouvelle page doit être ajoutée au meta.json de sa section.

On this page