Contribuer à la documentation

Où vivent les sources

Écrivez les pages publiées dans documentation/. MkDocs publie uniquement ce dossier.

Ne créez pas de page dans docs/ : ce dossier conserve la documentation développeur historique. Le dossier docs-plan/ contient le plan de publication ; il ne fait pas partie du site publié.

Prévisualiser en local

Installez les dépendances, puis démarrez le serveur de prévisualisation à la racine du dépôt :

pip install -r requirements.txt
mkdocs serve

Ouvrez ensuite l'adresse indiquée par MkDocs dans votre navigateur. Avant de proposer une modification, exécutez mkdocs build --strict.

Écrire une page

Appliquez ces règles à chaque page :

1. Rédigez en vouvoyant, avec des phrases courtes et le vocabulaire de la mairie.
2. Utilisez un seul titre de niveau 1, puis une hiérarchie de titres continue.
3. Reprenez les libellés de l'interface en gras, exactement comme ils s'affichent.
4. Utilisez !!! tip pour une astuce et !!! warning avant une action peu réversible.
5. Utilisez des données fictives, des liens explicites et un texte alternatif descriptif pour chaque image.

Ajoutez un lien vers le glossaire à la première occurrence d'un terme métier. La page doit suivre la structure définie dans le plan de publication : objectif, prérequis, étapes, résultat attendu et liens internes pour aller plus loin.

Régénérer les captures d'écran

Les captures versionnées sont dans documentation/assets/screenshots/. Leur nom est stable : conservez-le lorsqu'une page les utilise.

Depuis la racine du dépôt, exécutez :

npm run docs:screenshots

La commande recrée les 21 images à partir du jeu de données fictif prévu pour la documentation : commune de Montgeroult, foyer Rivière et personne autorisée Sophie Martin. Vérifiez visuellement les images modifiées avant de les versionner.