Synchroniser la doc avec le code
Objectif : garder doc-rilindra aligné avec les dépôts applicatifs.
Versions
Depuis doc-rilindra :
npm run doc:sync-versions
Le script lit les package.json attendus dans :
../vps/staff-rilindra
../vps/commu-rilindra
../vps/bot-rilindra
../doc-rilindra
Le tableau de Versions des dépôts est remplacé entre les marqueurs automatiques.
Checklist par changement
| Changement | Page à mettre à jour |
|---|---|
| Nouvelle variable Staff | Configuration Staff |
| Nouvelle variable Commu | Configuration Commu |
| Nouvelle variable Bot | Configuration Bot |
| Nouvelle route API critique | Page projet + configuration concernée |
| Migration DB | Runbook VPS production si la procédure change |
| Nouvelle décision technique | Architecture ou nouvelle page ADR |
| Changement de domaine | Intro, configuration et architecture |
| Changement Discord | Bot + configuration concernée |
| Changement MinIO | Architecture + projet concerné |
Règles
- Ne jamais écrire de secret dans la doc.
- Documenter les noms de variables, pas les valeurs.
- Mettre à jour la doc dans la même PR que le changement si possible.
- Si une page devient historique, la marquer comme telle au lieu de la supprimer.
- Les audits peuvent rester en archive, même s'ils mentionnent une ancienne infra.