Contribuer à la documentation

Cette page explique comment contribuer à la documentation de FirstBreath (site Docusaurus dans apps/docs).

Où écrire

• Anglais (source) : apps/docs/docs/ — ajoutez ou modifiez des fichiers .md dans la section appropriée (backend, frontend, vision, mobile, showcase, infrastructure, qa).
• Français : apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/ — reproduisez la même structure de dossier et traduisez le contenu.

Structure et conventions

• Utilisez Markdown (et MDX si nécessaire). Diagrammes : Mermaid (pris en charge par le thème).
• Chaque documentation doit avoir un frontmatter avec au moins sidebar_position (et optionnellement title, last_update: { date: "YYYY-MM-DD" }).
• Évitez les liens brisés : les liens internes utilisent des chemins comme /docs/backend/overview/intro. Exécutez npm run build pour détecter les liens brisés (onBrokenLinks: 'throw').

Modification depuis le site

Chaque page de documentation dispose d'un lien "Edit this page" (ou équivalent) qui pointe vers le dépôt. Il utilise l'editUrl dans docusaurus.config.ts (par ex. FirstBreath/FirstBreath-Platform/tree/main/apps/docs). Utilisez-le pour ouvrir le bon fichier sur GitHub.

Prévisualisation locale

Depuis apps/docs :

npm install
npm run start

Ouvrez http://localhost:3000. Pour le français : npm run start -- --locale fr puis http://localhost:3000/fr/.

Ajouter une nouvelle documentation

1. Créez le fichier .md dans docs/ sous la bonne section (par ex. docs/backend/guides/my-feature.md).
2. La barre latérale est générée automatiquement à partir de la structure des dossiers ; utilisez _category_.json dans un dossier pour définir son étiquette et son ordre.
3. Si la documentation est en français, ajoutez ou mettez à jour le fichier correspondant sous i18n/fr/docusaurus-plugin-content-docs/current/ avec le même chemin.

Contribution au dépôt complet

Voir CONTRIBUTING.md dans apps/docs pour le flux de travail de clonage, branche et PR spécifique à l'application de documentation.