Getting Started
Ce dossier sert de point d'entrée stable pour :
- Comprendre comment la documentation est organisée
- Savoir où chercher selon le sujet (tech, fonctionnel, chantier en cours)
- Démarrer rapidement quand on rejoint le projet
L'état courant (priorités, chantiers du moment) est centralisé dans
docs/index.mdet dans05_chantiers_actifs/.
Ce que ce dossier contient (et ne contient pas)
- Ici : des documents “onboarding” relativement stables (naviguer la doc, conventions, versioning, CI/CD, premières actions).
- Pas ici : le suivi au quotidien d'un chantier (ça va dans
05_chantiers_actifs/) ni l'historique (ça va dans_archives/).
Par où commencer ?
- Je veux l'état actuel / quoi faire maintenant
- Lire
docs/index.md -
Puis aller dans
05_chantiers_actifs/ -
Je veux comprendre le produit (métier / parcours)
-
Aller dans
02_fonctionnel/ -
Je veux comprendre l'architecture technique
- Aller dans
03_architecture_techniques/ - Puis
04_bonnes_pratiques/
Trouver une information rapidement
- Changements en cours :
05_chantiers_actifs/ - Choix techniques :
06_decisions/(ADR) - Historique / post-mortems :
_archives/
Contenu du dossier
- SETUP_GITHUB_ACTIONS.md — Mise en place des secrets et du workflow GitHub Actions pour publier sur Google Play.
- VERSIONING.md — Convention et workflow de versioning (versions + build number).
Note de cohérence (sources de vérité)
Certaines informations “process” existent aussi hors de docs/ (par exemple dans .github/).
- Si un document décrit le comportement d'un workflow, la source de vérité reste le fichier
.github/workflows/*.yml. - Si vous observez un écart entre la doc et le workflow, c'est généralement la doc qui doit être mise à jour.
À créer (quand on en aura besoin)
- [ ]
SETUP_LOCAL.md— Installation de l'environnement local