Améliorer ce manuel¶
Le manuel est écrit en Markdown sous docs/ et construit avec MkDocs.
Aperçu local¶
Créer un environnement et installer les dépendances :
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Ouvrir l’adresse affichée. L’aperçu se reconstruit après chaque modification.
Valider le site¶
Avant une pull request :
Le mode strict signale navigation manquante, liens invalides détectés et avertissements de configuration.
Principes d’écriture¶
- Écrire pour une tâche et un public précis.
- Indiquer la version lorsque le comportement en dépend.
- Préférer les exemples testés aux listes exhaustives.
- Ne jamais utiliser de vrais identifiants ou données privées.
- Relier les tâches associées au lieu de dupliquer de longs passages.
- Mettre à jour toutes les traductions ensemble.
Traductions¶
L’anglais est la référence. Allemand, français et espagnol utilisent le même chemin avec un suffixe :
Si une traduction manque, le site revient à l’anglais. Une traduction conserve code, réglages, avertissements et liens, avec une terminologie naturelle.
Périmètre¶
Cette documentation vise MRBS 1.12.2. Un changement décrivant une version ultérieure doit mettre à jour le périmètre visible ou appartenir à sa documentation dédiée.