2.0 KiB
2.0 KiB
Centralisation de la documentation (docs)
Objectif
Centraliser toute la documentation des projets dans 4NK_env/docs/<projet>/
et supprimer les dossiers docs/
des sous‑projets (sans symlinks à terme).
État actuel
- Dossiers centralisés disponibles:
4NK_env/docs/lecoffre_node
,4NK_env/docs/lecoffre-front
,4NK_env/docs/ihm_client
,4NK_env/docs/sdk_relay
,4NK_env/docs/sdk_storage
. - Les projets pointent désormais vers la documentation centralisée (READMEs mis à jour).
Politique
- Emplacement unique:
4NK_env/docs/<projet>/
. - Pas de duplication ni de divergence documentaire dans les sous‑projets.
- Les références dans README, CI et scripts doivent pointer vers le chemin centralisé.
- Ne faite pas de nouveaux fichier md mais complete les fichiers existants
Actions (TODO)
- Vérifier qu’aucun
docs/
résiduel n’existe dans les sous‑projets. - Mettre à jour toutes les références vers
4NK_env/docs/<projet>/
(READMEs, scripts, CI, prompts). - Supprimer les symlinks résiduels
docs/
dans les sous‑projets une fois la migration validée.
Bonnes pratiques
- Regrouper par thèmes:
architecture/
,installation/
,deployment/
,specs_func/
,specs_tech/
,streams/
,quality/
,security/
,TODO/
. - Éviter les copies statiques de configurations sensibles; référencer
4NK_env/confs/<projet>/
. - Cohérence des intitulés et formats (Markdown lint).
Vérifications
- Rechercher des références obsolètes:
grep -R "\bdocs/\b" /home/debian/4NK_env | grep -v "/home/debian/4NK_env/docs/" || true
- S’assurer que les READMEs des projets mentionnent explicitement
4NK_env/docs/<projet>/
.
Exclusions (ne pas centraliser)
- Conserver la documentation intégrée du front:
lecoffre-front/src/front/Assets/docs/
- Conserver les fichiers racine par projet:
README.md
,CHANGELOG.md
,CONTRIBUTING.md
État actuel
- Scan effectué. Exclusions ci-dessus appliquées.
- Centralisation uniquement des autres contenus de documentation si présents.