Documentation Feelbat App
Documentation développeur de l'application mobile Feelbat. Nouveau sur le projet ? Commencez par l'onboarding.
| Page | Contenu |
|---|---|
| Onboarding | Ce qu'est Feelbat, prérequis, installation, lancement de l'application — à lire en premier |
| Architecture | Structure, alias de modules, état, couche de données, offline-first, frontières |
| Navigation | Arbre des navigateurs, noms de routes, paramètres typés, garde d'authentification, modales |
| Règles de code | Nommage, structure des composants, thème, i18n, état — les conventions suivies |
| Tests | Jest, mocks, patterns, dependency-cruiser, Detox |
| CI/CD | GitHub Actions, DangerJS, hooks git, portes qualité |
| Release | Environnements, versioning, Fastlane, publication sur les stores |
| Troubleshooting | Pièges connus et écueils d'installation |
| ADR | Architecture Decision Records — le « pourquoi » |
Maintenir cette documentation
- Après avoir construit une feature, lancez
/doc-feature— la commande met à jour les pages concernées et génère un README de feature + un ADR. - Après un changement significatif hors feature (CI, outillage, conventions, dépendances), lancez
/doc-update. - Les ADR sont immuables une fois acceptés — on les remplace, on ne les réécrit pas.
Référence API (TypeDoc)
Dans le dépôt de l'application, yarn docs:api génère une référence API au format Markdown à partir des commentaires TSDoc de l'API publique de chaque feature (src/features/*/index.ts). Cette référence est générée localement dans le dépôt applicatif et n'est pas publiée sur ce site. Documentez vos exports selon la skill tsdoc pour que la référence reste complète.
Publication vers le site de documentation central
scripts/build-mobile-docs.sh <target> assemble ces pages + les README de features + la référence TypeDoc en une arborescence prête pour MkDocs (liens réécrits), destinée au dépôt de documentation central de l'organisation. Ce script est utilisé par la skill sync-mobile-docs.
Voir aussi le README.md racine, le CLAUDE.md (principes de qualité de code) et l'AGENTS.md (règles du dépôt).