Roadmap — Hub de documentation ENGWE
Doc interne — état d'avancement du hub de documentation lui-même (ce repo
ENGWE-FRANCE/Documentation).
✅ Ce qui est fait
Infrastructure & CI/CD
- Site statique généré par
scripts/build-site.mjs(Node.js/ESM, zéro dépendance lourde) - Déploiement automatique sur GitHub Pages via GitHub Actions (workflow
docs-synchro-deploiement.yml) - Synchro automatique quotidienne des docs des projets (clone + copy depuis les repos frères)
- Support des repos ENGWE-FRANCE (synchro CI) et repos externes/perso MaashRees (synchro locale seulement)
-
_meta.jsonauto-généré par le script de synchro (commit, fichiers, date) - Liens 100 % relatifs → fonctionne en local (
file://) et sous/Documentation/sur GitHub Pages - Réécriture automatique des liens
.md→.htmldans le rendu
Design & UX
- Thème orange/noir/blanc, dark mode / light mode avec bascule
- Navigation top-bar : Accueil, Projets, Agents, Architecture, Guides, Créer un agent
- Page d'accueil avec hero, marques du groupe, projets phares, agents techniques
- Page projet : hero, meta-panel (repo, marque, statut, dernière synchro), docs groupées par catégorie
- Sidebar de navigation dans les docs de projet (Documentation / Process / Sprints / Backlog)
- Page Agents : catalogue complet avec fiches (Identité, Âme, Mémoire, Guide)
- Page Architecture
- Page Guides (projets + agents)
- Page "Créer un agent"
- Breadcrumb sur toutes les pages
- Micro-animations stagger à l'entrée des cards
Contenu
- 5 projets référencés : MJY Task Platform, Gestion RH, KOBIKE Tracking Notifier, VPS Hostinger, KOBIKE Client Flow
- Agents documentés : Authority, Praesidia, agents-domaine, agents de veille
- ADR, sprints, backlogs, rapports de sprint synchronisés pour
mjy-task-platform -
projects.jsonetagents.jsoncomme sources de vérité - Logo ENGWE + favicon dans le hub (topbar + onglet navigateur)
- Tous les repos de l'org
ENGWE-FRANCEautorisés en synchro CI - Sprints retiré du menu principal — lien discret dans le footer
- Page Roadmap (
/roadmap/) - Page "Démarrer un projet" avec templates et prompts (
/demarrer-projet/)
🔲 Ce qui reste à faire
Priorité haute
- Résolution des conflits de merge automatique : ajouter un step CI qui vérifie l'absence de marqueurs
<<<<<<< HEADavant le build (guard script) - BOM UTF-8 : s'assurer que le script de synchro écrit en UTF-8 sans BOM (corriger le script de synchro)
- Ajouter
gestion-rhetkobike-tracking-notifierdans la synchro CI (vérifier les permissions GitHub Actions)
Priorité moyenne
- Recherche full-text dans le site (client-side, ex: Fuse.js ou lunr.js)
- RSS / atom feed pour les nouvelles docs synchronisées
- Badge "dernière synchro" plus visible sur les cards projet de la page d'accueil
- Page 404 personnalisée pour GitHub Pages
- Sitemap.xml auto-généré pour le SEO
- Ajouter
gestion-rhetkobike-tracking-notifierdans la synchro CI (vérifier les permissions GitHub Actions)
Priorité basse / idées
- Mode "présentation" : vue épurée pour partager avec quelqu'un d'externe (sans les sprints/backlog)
- Stats de build : nombre de pages générées, taille du site, affiché dans le footer
- Historique des synchros : page dédiée avec le log des dernières synchros par projet
- Notifications : alerte quand un nouveau doc est synchronisé (webhook Discord ou email)
- Ajouter le projet
miyan-noodlesquand il aura un repo
📝 Notes techniques
Comment ajouter un projet
- Créer le repo sous
ENGWE-FRANCE/(ou noterexternal: trues'il est sous MaashRees) - Ajouter une entrée dans
projects.json - La synchro CI s'en occupera automatiquement à la prochaine run
Convention de nommage des fichiers docs
| Pattern | Catégorie | Section |
|---|---|---|
sprint_*.md |
Sprints | Sprints |
*backlog*.md |
Backlog | Backlog |
*process*, *utilisation* |
Process | Process d'utilisation |
| tout le reste | Documentation | Documentation |
Problèmes connus
- Les repos
external: truene se synchronisent pas en CI (pas de token cross-compte). Synchro locale seulement vianpm run sync. - Le script de synchro PowerShell (
WriteAllText) peut introduire un BOM UTF-8 — corriger avecWriteAllBytesen UTF-8 sans BOM. - Les merges automatiques de la synchro CI peuvent créer des conflits si une modif manuelle est faite en parallèle sur
main. Toujours merger depuismainavant de pousser manuellement.
