https://github.com/Avenir-Motard/Documentation
Ce repository est la source officielle de la documentation d'Avenir Motard.
Il contient les pages Markdown qui alimentent la documentation technique et les guides de contribution (dev et non-dev).
Avenir Motard utilise Wiki.js pour sa documentation.
Le projet Documentation a 3 objectifs:
- Centraliser les regles et procedures (contribution, qualite, checks).
- Faciliter l'onboarding des nouveaux contributeurs.
- Garantir une base de connaissance claire et maintenue dans le temps.
Vous trouverez principalement:
- des pages d'accueil et d'orientation,
- des guides de contribution,
- des pages projet (Bot, Documentation, etc.),
- des guides de qualite et de validation,
- des pages PocketBase (schema, usage, UI).
Cette documentation est ecrite pour:
- les contributeurs non-dev (process, checks, bonnes pratiques),
- les developpeurs (architecture, qualite, organisation),
- les maintainers (standardisation et revue).
- Identifier la page a mettre a jour.
- Faire une modification courte et ciblee.
- Verifier la coherence des liens internes.
- Faire relire avant publication si le changement est important.
Liens utiles:
- Preferer des phrases courtes et concretes.
- Expliquer le pourquoi avant le comment.
- Ajouter des exemples de sortie quand un check est mentionne.
- Garder une structure homogene entre pages (Description, Validation, Echec, Resolution).
Une bonne page doit:
- repondre a une question precise,
- guider vers l'action suivante,
- rester comprehensible sans contexte technique avance.