Écrire et consulter la documentation

Écrire de la doc

Chaque dépôt applicatif contient sa documentation dans un dossier docs/ à la racine. Cette documentation est automatiquement synchronisée et intégrée au portail docusaurus global à chaque merge sur la branche dev.

Il vous est recommandé d'utiliser un dossier internal/ pour tout documentation qui vous écrirez pour votre propre équipe et de placer le reste directement dans docs/. Ajoutez uniquement des fichiers markdown (.md) ou des dossiers.

Exemple de structure recommandée :

📁 docs/
├── intro.md
├── api.md
└── internal/
    └── spec_interne.md

Un fichier README.md à la racine du dépôt sera également inclus dans la documentation Docusaurus.

Ajouter un en-tête avec title: et, si nécessaire, sidebar_position:

Consulter la doc

Pour consulter la documentation des autres applications, dans la sidebar, chaque application dispose de sa propre section nommée d'après son nom.