Skip to content

Latest commit

 

History

History
116 lines (90 loc) · 6.62 KB

README.md

File metadata and controls

116 lines (90 loc) · 6.62 KB

Documentation — index et source de vérité

Cette arborescence est la source documentaire versionnée du projet. Ses documents sont relus avec le code dans les issues, branches et pull requests. Le wiki GitHub présente un parcours de lecture simplifié ; il ne remplace pas les documents canoniques du dépôt.

Lire selon son besoin

Besoin Document recommandé
Découvrir le produit et ses capacités réelles README principal
Suivre l'avancement de la release active Roadmap produit mesurable
Utiliser l'application en français Guide utilisateur
Utiliser l'application en anglais User guide
Sauvegarder, restaurer ou comprendre les instantanés Guide des sauvegardes
Comprendre les choix structurants Décisions d'architecture
Connaître la suite après 1.0.0 Roadmap après la v1.0
Comprendre un terme Glossaire

project/ — vision, méthode et références

decisions/ — pourquoi ces choix

Une décision acceptée explique son contexte, ses limites et les solutions écartées. Elle ne doit pas annoncer comme livrée une capacité seulement prévue.

roadmaps/ — séquences détaillées

Seul le périmètre explicitement délimité dans ROADMAP.md détermine le pourcentage de la release en cours. Les objectifs futurs restent visibles sans diminuer artificiellement ce pourcentage.

releases/ — versions et distribution

  • Release v1.0.0 : notes de première publication, fonctionnalités, fichiers distribués et limites connues.
  • Guide d'installation statique : intégrité SHA-256, extraction, hébergement et précautions sur les données locales.

contracts/ — échanges et compatibilité

Les fichiers companion-issues/ documentent des propositions pour les dépôts compagnons ; ils ne signifient pas qu'une modification y a déjà été appliquée.

history/ et documents de travail hérités

Pour une décision actuelle, consulter prioritairement ROADMAP.md, DR-006 et la roadmap après 1.0.0 plutôt qu'un document de travail historique.

Publication du wiki

Le wiki GitHub possède son propre dépôt Git, imposé par GitHub. Il est utilisé comme miroir utilisateur en français : accueil, démarrage, progression, chantiers, sauvegardes, thèmes/accessibilité et limites connues. Les références techniques détaillées restent liées au dépôt principal.

  • wiki/Home.md : accueil synthétique du wiki utilisateur.
  • wiki/_Sidebar.md : navigation latérale du wiki.
  • scripts/wiki/build-wiki.mjs : génération des pages depuis leurs documents canoniques et adaptation des liens relatifs.
  • .github/workflows/sync-wiki.yml : publication automatique vers le dépôt wiki séparé après modification de la documentation sur main.

Création assistée d'issues GitHub

Le workflow manuel Seed GitHub Issues utilise :

  • .github/workflows/seed-issues.yml ;
  • scripts/github/create_github_issues.ps1 ;
  • scripts/github/issues.ide-projectsmanager.next-batch.json.

Lancer d'abord le workflow avec dry_run = true, contrôler le résultat, puis utiliser dry_run = false uniquement pour le lot réellement validé.