--- id: contributing-docs title: Guide de Contribution sidebar_label: Guide de Contribution description: Comment contribuer à la documentation Veza keywords: [veza, contribution, documentation, guide] --- # 🤝 Guide de Contribution Comment contribuer à la documentation Veza Platform. ## 🎯 Vue d'Ensemble Ce guide explique comment contribuer à la documentation Veza Platform de manière efficace et cohérente. ## 📝 Types de Contributions ### 📚 Documentation - **Corrections** de contenu - **Ajouts** de nouvelles sections - **Améliorations** de la structure - **Traductions** en d'autres langues ### 🎨 Améliorations - **Design** et mise en page - **Navigation** et organisation - **Diagrammes** et illustrations - **Exemples** et tutoriels ## 🔧 Processus de Contribution ### 1. Fork et Clone ```bash # Fork le repository sur GitHub # Puis cloner votre fork git clone https://github.com/votre-username/veza-full-stack.git cd veza-full-stack ``` ### 2. Branche de Travail ```bash # Créer une branche pour votre contribution git checkout -b docs/amélioration-description ``` ### 3. Modifications - Modifier les fichiers dans `veza-docs/` - Tester localement avec `npm run start` - Vérifier la qualité avec `npm run lint` ### 4. Pull Request - Commiter vos changements - Pousser vers votre fork - Créer une PR sur GitHub ## 📋 Standards de Qualité ### Contenu - **Clarté** et précision - **Cohérence** avec le style existant - **Exemples** pratiques et fonctionnels - **Liens** vérifiés et fonctionnels ### Format - **Markdown** propre et structuré - **Frontmatter** correctement rempli - **Images** optimisées et nommées - **Diagrammes** Mermaid fonctionnels ## 🛠️ Outils de Développement ### Installation ```bash cd veza-docs npm install ``` ### Commandes ```bash # Démarrer le serveur de développement npm run start # Construire la documentation npm run build # Linter et formater npm run lint npm run format # Vérifier les liens npm run check-links ``` ## 📚 Structure de la Documentation ### Organisation ``` veza-docs/ ├── docs/ │ ├── overview/ # Vue d'ensemble │ ├── architecture/ # Architecture │ ├── sectors/ # Applications │ ├── backend/ # Services backend │ ├── infra/ # Infrastructure │ ├── api-reference/ # Référence API │ ├── product/ # Produit │ └── meta/ # Métadonnées ``` ### Conventions - **Fichiers** : `index.mdx` pour les pages principales - **IDs** : kebab-case pour les identifiants - **Titres** : Emojis et formatage cohérent - **Liens** : Relatifs et vérifiés ## 🎨 Style Guide ### Titres ```markdown # 🎯 Titre Principal ## 🚀 Sous-titre ### 📋 Section ``` ### Code ```markdown ```bash # Commande shell npm run build ``` ```yaml # Configuration YAML version: '3.8' services: api: image: veza/api:latest ``` ``` ### Diagrammes ```markdown ```mermaid flowchart TB A[Start] --> B[Process] B --> C[End] ``` ``` ## 🔍 Vérifications ### Avant de Soumettre - [ ] Contenu vérifié et testé - [ ] Liens fonctionnels - [ ] Diagrammes Mermaid corrects - [ ] Linting passé - [ ] Build réussi ### Checklist PR - [ ] Description claire des changements - [ ] Screenshots si nécessaire - [ ] Tests de régression - [ ] Documentation mise à jour ## 📞 Support ### Questions - **GitHub Issues** : [Créer une issue](https://github.com/okinrev/veza-full-stack/issues) - **Discussions** : [Forum communautaire](https://github.com/okinrev/veza-full-stack/discussions) - **Slack** : #documentation ### Ressources - [Style Guide](/docs/meta/style-guide) ## 🎉 Reconnaissance Les contributeurs sont reconnus dans : - **README** du projet - **CHANGELOG** des versions - **Page Contributors** de la documentation Merci de contribuer à Veza Platform ! 🚀