Contribuer à la documentation

Modifier une page

Les fichiers Markdown sont sous documentation/docs/. Le menu est défini dans documentation/mkdocs.yml. Ajoutez chaque nouvelle page à la navigation et utilisez des liens relatifs pour les autres pages.

Chaque procédure doit préciser son objectif, les données à saisir, le résultat attendu et les erreurs utiles. Pour un stock, utilisez un exemple numérique et distinguez poids en vrac, pots, ventes et encaissements.

Vérifier

.venv/bin/mkdocs build --strict -f documentation/mkdocs.yml
docker compose -p ruchepilot-site-preview -f compose.local.yml up -d --build

Le build strict détecte les erreurs de configuration et certains liens manquants. Vérifiez aussi manuellement les pages en largeur mobile, la navigation, la recherche, les accents et les commandes à copier.

Mettre à jour avec une release

Comparez les changements d'application, les routes, formulaires, règles de validation et migrations. Actualisez les exemples, la version d'installation et la matrice de sources. Ne présentez pas une fonction retirée comme encore disponible.

Aucune capture ne doit contenir des comptes, mots de passe, coordonnées clients ou données réelles de production. Préférez des données fictives.

La documentation est construite avec la présentation et publiée sous https://levecadre.fr/docs/. Les procédures de construction et de déploiement sont dans le README du dépôt levecadre.fr.