Synchroniser la doc avec le code
Objectif : quand tu modifies un dépôt applicatif, savoir quoi mettre à jour dans doc-rilindra sans tout relire.
Commande rapide — versions
À la racine de doc-rilindra :
npm run doc:sync-versions
Met à jour le tableau des versions dans Versions des dépôts à partir des package.json des dossiers voisins (Calendrier-staff-Rilindra, quiz, rilindra-bot, doc-rilindra). Le contenu entre les lignes @@@AUTO_VERSIONS_TABLE_START@@@ et @@@AUTO_VERSIONS_TABLE_END@@@ est régénéré automatiquement (ne pas éditer ce bloc à la main).
Checklist par type de changement
| Tu changes… | Mets à jour dans doc-rilindra… | Et dans le dépôt d’origine… |
|---|---|---|
| Nouvelle variable d’env (Staff) | Configuration Staff Manager, Inventaire si nouveau fichier clé | .env.example, docs/setup/installation.md |
| Nouvelle variable (Quiz) | Configuration Quiz | src/lib/env.ts, README.md |
Nouvelle clé config.js (Bot) | Configuration Bot | docs/DOCUMENTATION_INTEGRALE.md (section config) |
| Nouveau domaine / redirect OAuth | Page config du projet concerné + Déploiement Vercel si impact doc | README / docs/setup du projet |
| Gros refacto API (nouveaux préfixes de routes) | Staff Manager config (tableau des préfixes) ou Quiz | README ou docs/reference/architecture.md |
| Schéma SQL / tables | Résumé dans la page config + lien vers fichier .sql dans Inventaire | Migration / script SQL dans le dépôt |
| Nouvelle appli ou renommage de dépôt | Vue d’ensemble intro, Architecture, inventaire | — |
Règles simples
- Une source de vérité : les détails longs restent dans chaque repo ; ici on garde des tableaux courts et des liens.
- Après une PR qui touche l’environnement ou la config, ajoute une ligne au changelog du dépôt et vérifie la ligne correspondante du tableau ci-dessus.
- Le script
doc:sync-versionsne lit que lespackage.json: pour le contenu fonctionnel, la revue manuelle reste nécessaire.
Emplacement des dépôts pour le script
Le script sync-doc-versions suppose que les dossiers Calendrier-staff-Rilindra, quiz, rilindra-bot et doc-rilindra sont au même niveau (répertoire parent commun). Si ton arborescence diffère, adapte scripts/sync-doc-versions.mjs.