Mise à jour de la documentation
Les pages de référence sont générées depuis le code de l’API. Les pages d’architecture, de conventions, de modules et d’ADR restent éditables à la main.
Structure recommandée
kibzi/
├── api/
├── web/
└── docs/
Générer les pages de référence
Depuis le dossier docs :
npm run generate:kibzi
Ou directement :
node scripts/generate-kibzi-docs.mjs --api-root ../api --docs-root docs/kibzi
Lancer la documentation localement
npm install
npm run start
La documentation est ensuite disponible sur :
http://localhost:3000
Règle d’or
Ne pas modifier manuellement les fichiers suivants après génération :
docs/kibzi/reference/routes.md
docs/kibzi/reference/entities.md
docs/kibzi/reference/enums.md
docs/kibzi/reference/payloads.md
docs/kibzi/reference/exceptions.md
docs/kibzi/reference/environment.md
docs/kibzi/reference/source-audit.md
docs/kibzi/_generated/source-snapshot.json