docs: harmonize markdown files with actual repository state #3

2026-02-12T21:02:43Z

electron-rare commented

2026-02-12 21:02:43 +00:00

(Migrated from github.com)

Motivation

Rendre la documentation fidèle à l’arborescence versionnée et clarifier l’état d’avancement des sous-projets (Kit MJ, Printables, Hardware) sans toucher au firmware.
Stabiliser la zone "printables" en matérialisant les dossiers src/ et export/{pdf,png}/ et fournir des README/placeholder pour faciliter les revues PR et les exports futurs.
Fournir un audit et un plan de maintenance accessibles depuis la racine pour guider les contributions documentaires et les revues périodiques.

Description

Mise à jour de README.md pour refléter l’état actuel du projet et exposer les liens vers docs/maintenance-repo.md et docs/repo-audit.md.
Révision de CHANGELOG.md (Unreleased) pour documenter la revue de cohérence et l’ajout du dossier d’export Kit MJ.
Ajout de docs/maintenance-repo.md et docs/repo-audit.md pour planifier la maintenance documentaire et livrer l’audit de cohérence (couverture de revue, conclusions, recommandations).
Création/renforcement de la zone Printables avec printables/src/README.md, printables/export/{pdf,png}/README.md, printables/invitations/* placeholders (.gitkeep) et mise à jour de printables/README.md et printables/invitations/README.md pour indiquer l’état actuel.
Aligment du Kit MJ en ajoutant kit-maitre-du-jeu/export/pdf/README.md et en ajustant kit-maitre-du-jeu/README.md pour indiquer que le dossier d’exports est prêt.

Testing

Vérification automatique des liens Markdown interne via un script Python de contrôle de liens; résultat: 0 liens Markdown cassés.
Scan des assets image via rg pour détecter fichiers image versionnés; résultat: aucune image trouvée (attendu) et recommandation d’ajouter previews PNG dans printables/export/png/.
Inspection de contenu des fichiers modifiés avec commandes de pagination (nl/sed) pour valider les textes ajoutés et les readme créés; vérifications OK.
Validation que la nouvelle arborescence et les README/placeholder sont présents et lisibles; vérification OK.

Codex Task

### Motivation - Rendre la documentation fidèle à l’arborescence versionnée et clarifier l’état d’avancement des sous-projets (Kit MJ, Printables, Hardware) sans toucher au firmware. - Stabiliser la zone "printables" en matérialisant les dossiers `src/` et `export/{pdf,png}/` et fournir des README/placeholder pour faciliter les revues PR et les exports futurs. - Fournir un audit et un plan de maintenance accessibles depuis la racine pour guider les contributions documentaires et les revues périodiques. ### Description - Mise à jour de `README.md` pour refléter l’état actuel du projet et exposer les liens vers `docs/maintenance-repo.md` et `docs/repo-audit.md`. - Révision de `CHANGELOG.md` (`Unreleased`) pour documenter la revue de cohérence et l’ajout du dossier d’export Kit MJ. - Ajout de `docs/maintenance-repo.md` et `docs/repo-audit.md` pour planifier la maintenance documentaire et livrer l’audit de cohérence (couverture de revue, conclusions, recommandations). - Création/renforcement de la zone Printables avec `printables/src/README.md`, `printables/export/{pdf,png}/README.md`, `printables/invitations/*` placeholders (`.gitkeep`) et mise à jour de `printables/README.md` et `printables/invitations/README.md` pour indiquer l’état actuel. - Aligment du Kit MJ en ajoutant `kit-maitre-du-jeu/export/pdf/README.md` et en ajustant `kit-maitre-du-jeu/README.md` pour indiquer que le dossier d’exports est prêt. ### Testing - Vérification automatique des liens Markdown interne via un script Python de contrôle de liens; résultat: `0` liens Markdown cassés. - Scan des assets image via `rg` pour détecter fichiers image versionnés; résultat: aucune image trouvée (attendu) et recommandation d’ajouter previews PNG dans `printables/export/png/`. - Inspection de contenu des fichiers modifiés avec commandes de pagination (`nl`/`sed`) pour valider les textes ajoutés et les readme créés; vérifications OK. - Validation que la nouvelle arborescence et les README/placeholder sont présents et lisibles; vérification OK. ------ [Codex Task](https://chatgpt.com/codex/tasks/task_e_698e27fcdd20833194b09d00e44ed868)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: electron-rare/le-mystere-professeur-zacus#3