Aller au contenu

ADR-0001 - Publier une documentation technique publique sur Hostinger

Statut

Accepte

Date

2026-09-18

Contexte

Solutravo contient plusieurs modules metier dont la reprise est difficile si la connaissance reste dans l'historique Git, les discussions orales ou le code uniquement.

La documentation doit etre accessible via une URL et rester versionnee avec le code.

Decision

Publier la documentation technique avec MkDocs Material sous forme de site statique heberge sur Hostinger.

URL cible :

https://docs.solutravo-app.fr

Consequences

  • La documentation vit dans le depot, sous docs/.
  • Les modifications documentaires passent par Git et peuvent etre relues.
  • Le workflow GitHub Actions construit le site avec mkdocs build --strict.
  • Le dossier statique site/ est deploye par FTP sur Hostinger.
  • Les identifiants FTP restent dans les secrets GitHub Actions.
  • Le repertoire distant cible est configure par variable GitHub Actions.
  • Le contenu doit etre utile aux developpeurs tout en restant compatible avec une exposition publique.

Regle de securite

Les noms de fichiers, classes, routes, tables, variables d'environnement et flux techniques peuvent etre documentes. Les valeurs secretes, tokens, cles API, mots de passe, donnees client et details d'infrastructure sensibles ne doivent pas etre publies.