docs
This commit is contained in:
@@ -3,8 +3,14 @@
|
||||
Statut: `migration partielle`
|
||||
Dernière mise à jour: `2026-05-13`
|
||||
|
||||
Ce dossier devient la source de lecture thématique pour les règles business du
|
||||
module `purchase_trade`.
|
||||
Ce dossier devient la source de lecture thématique publiée dans le wiki pour les
|
||||
règles business du module `purchase_trade`.
|
||||
|
||||
Certaines pages peuvent être générées depuis une source de vérité plus sobre,
|
||||
rangée hors du dossier wiki dans `modules/purchase_trade/docs_source/`. Dans ce
|
||||
cas, la page publiée dans `modules/purchase_trade/docs/` porte un commentaire
|
||||
`Generated from ...` en tête de fichier et ne doit pas être modifiée
|
||||
directement.
|
||||
|
||||
Chaque page doit rester lisible par deux publics:
|
||||
|
||||
@@ -31,6 +37,21 @@ Toute modification d'une règle business, d'un statut, d'un champ technique ou
|
||||
d'un point de vigilance doit être reportée dans les deux pages au même moment.
|
||||
Les deux pages doivent indiquer leur page miroir en en-tête.
|
||||
|
||||
## Convention source / wiki
|
||||
|
||||
Pour les pages qui ont besoin d'une présentation riche dans MkDocs:
|
||||
|
||||
- éditer la source de vérité dans `modules/purchase_trade/docs_source/`;
|
||||
- régénérer la version wiki avec:
|
||||
|
||||
```bash
|
||||
python modules/purchase_trade/docs/tools/render_business_docs.py
|
||||
```
|
||||
|
||||
Le rendu wiki privilégie du HTML simple et portable plutôt que des extensions
|
||||
MkDocs optionnelles. Cela évite d'exposer dans le wiki des marqueurs non rendus
|
||||
comme `!!!` ou `:material-...:`.
|
||||
|
||||
## Convention de rédaction
|
||||
|
||||
Pour chaque règle durable, utiliser autant que possible ce format:
|
||||
|
||||
Reference in New Issue
Block a user