ADR-0001 - Publier une documentation technique publique sur Hostinger¶
Statut¶
Accepte
Date¶
2026-09-18
Contexte¶
Solutravo contient plusieurs modules métier dont la reprise est difficile si la connaissance reste dans l'historique Git, les discussions orales ou le code uniquement.
La documentation doit être accessible via une URL et rester versionnée avec le code.
Decision¶
Publier la documentation technique avec MkDocs Material sous forme de site statique heberge sur Hostinger.
URL cible :
Conséquences¶
- La documentation vit dans le dépôt, sous
docs/. - Les modifications documentaires passent par Git et peuvent être relues.
- Le workflow GitHub Actions construit le site avec
mkdocs build --strict. - Le dossier statique
site/est déployé par FTP sur Hostinger. - Les identifiants FTP restent dans les secrets GitHub Actions.
- Le répertoire distant cible est configure par variable GitHub Actions.
- Le contenu doit être utile aux développeurs tout en restant compatible avec une exposition publique.
Regle de sécurité¶
Les noms de fichiers, classes, routes, tables, variables d'environnement et flux techniques peuvent être documentes. Les valeurs secretes, tokens, clés API, mots de passe, données client et détails d'infrastructure sensibles ne doivent pas être publies.