docs: améliorer rendu markdown et navigation mkdocs
- Ajouter ADR-018 (librairies Go) dans TECHNICAL.md - Transformer Shared en menu dépliable dans mkdocs (cohérence avec autres domaines) - Corriger listes markdown (ajout lignes vides avant listes) - Corriger line breaks dans génération BDD (étapes "Et" sur nouvelles lignes) - Ajouter script fix-markdown-lists.sh pour corrections futures Impacte 86 fichiers de documentation et 164 fichiers BDD générés.
This commit is contained in:
@@ -74,6 +74,7 @@ Fonctionnalité: Recherche avancée de contenus
|
||||
```
|
||||
|
||||
**Conventions Gherkin** :
|
||||
|
||||
- Langue française (`# language: fr`)
|
||||
- Mots-clés : `Fonctionnalité`, `Scénario`, `Étant donné`, `Quand`, `Alors`
|
||||
- Commentaires pour référencer les règles DDD
|
||||
@@ -94,6 +95,7 @@ Cette commande :
|
||||
Si la catégorie n'existe pas encore, l'ajouter :
|
||||
|
||||
```yaml
|
||||
|
||||
- '🎯 Recommendation':
|
||||
# ...
|
||||
- Tests BDD:
|
||||
@@ -156,6 +158,7 @@ Description du contexte métier...
|
||||
**Justification** : Parce que...
|
||||
|
||||
**Exemple** :
|
||||
|
||||
- Cas nominal : ...
|
||||
- Cas d'erreur : ...
|
||||
|
||||
@@ -177,6 +180,7 @@ Les règles métier doivent être testables → créer des features BDD.
|
||||
### Étape 5 : Ajouter dans `mkdocs.yml`
|
||||
|
||||
```yaml
|
||||
|
||||
- '🎙️ Content':
|
||||
- Règles:
|
||||
- Création & Publication: domains/content/rules/creation-publication.md
|
||||
@@ -234,6 +238,7 @@ Requêtes sqlc : `backend/queries/nouvelle_thing.sql`
|
||||
### Ajouter dans `mkdocs.yml`
|
||||
|
||||
```yaml
|
||||
|
||||
- Entités:
|
||||
- Vue d'ensemble: domains/[domain]/entities/vue-ensemble.md
|
||||
- Nouvelle Entité: domains/[domain]/entities/nouvelle-entite.md # ← NOUVEAU
|
||||
@@ -268,6 +273,7 @@ sequenceDiagram
|
||||
## Légende
|
||||
|
||||
**Acteurs** :
|
||||
|
||||
- Utilisateur : Client de l'API
|
||||
- API : Backend RoadWave
|
||||
- Database : PostgreSQL
|
||||
|
||||
Reference in New Issue
Block a user