0003 — Repo hub unique pour la documentation
Contexte
- Nécessité d'un point central pour orchestrer documentation, scripts et notes sans les disperser.
- Présence de multiples projets indépendants qui doivent coexister sans polluer la structure documentaire.
- Besoin de garder une vue d'ensemble cohérente sur le système malgré la diversité des projets.
Décision
- Utiliser un dépôt principal nommé « hub » comme point d'ancrage du système.
- Centraliser dans ce dépôt :
- la documentation (
docs/) - les scripts (
scripts/) - les notes (
notes/)
- la documentation (
- Ne pas créer de dépôt séparé dédié à la documentation.
- Limiter
projects/à un rôle de conteneur pour des dépôts Git indépendants.
Raisons
- Assurer la cohérence globale du système et des décisions.
- Simplifier la navigation, la maintenance et la découverte des artefacts.
- Éviter la duplication d'information entre plusieurs dépôts.
- Maintenir une visibilité claire sur l'architecture et les choix documentés.
- Profiter de l'intégration native avec Rspress pour la documentation.
Conséquences
Positives
- Source de vérité unique pour l'ensemble du système.
- Structure centralisée facile à parcourir et à faire évoluer.
- Itération accélérée grâce à une organisation homogène.
- Lisibilité accrue pour l'usage personnel et les décisions associées.
Négatives
- Taille du dépôt hub plus importante.
- Responsabilité accrue sur le dépôt principal (revue, CI, documentation).
- Besoin de gérer strictement la frontière avec les projets indépendants pour éviter les fuites de contenu.
Alternatives considérées
- Dépôt dédié uniquement à la documentation — rejeté pour cause de duplication et d'efforts redondants.
- Monorepo englobant les projets — rejeté pour préserver l'isolation et l'autonomie de chaque projet.
- Documentation dispersée dans chaque projet — rejeté car elle diluerait la vision globale.
Statut
Accepté.