Skip to content

README.md

Latest commit

 

History

History
100 lines (78 loc) · 2.69 KB

README.md

File metadata and controls

100 lines (78 loc) · 2.69 KB

Documentation matos.live

Ce dossier contient la documentation technique de l'application matos.live.

📚 Documentation disponible

SITEMAP.md

Documentation complète du système de sitemap :

  • Architecture et composants
  • Configuration et personnalisation
  • Endpoints disponibles
  • Utilisation et commandes
  • Extension du système
  • Performance et optimisation
  • Dépannage et maintenance

HELLOASSO_INTEGRATION.md

Documentation de l'intégration HelloAsso :

  • Configuration de l'API
  • Synchronisation des organisations
  • Gestion des webhooks
  • Authentification OAuth

🚀 Utilisation

Consulter la documentation

# Ouvrir la documentation dans un éditeur
code docs/

# Ou consulter directement
cat docs/SITEMAP.md

Mise à jour de la documentation

  1. Modifier le fichier Markdown correspondant
  2. Vérifier la syntaxe Markdown
  3. Tester les exemples de code
  4. Commiter les changements

📝 Conventions

Structure des fichiers

  • Nommage : NOM_DU_SYSTEME.md (en majuscules)
  • Format : Markdown avec syntaxe GitHub
  • Encodage : UTF-8

Contenu

  • Vue d'ensemble : Description générale du système
  • Architecture : Composants et interactions
  • Configuration : Paramètres et variables d'environnement
  • Utilisation : Exemples et commandes
  • Extension : Comment personnaliser/étendre
  • Dépannage : Problèmes courants et solutions

Code

  • Exemples PHP : Syntaxe Laravel 11
  • Commandes : Terminal avec syntaxe bash
  • Configuration : Fichiers de config Laravel
  • Variables d'environnement : Format .env

🔧 Outils recommandés

Éditeurs

  • VS Code : Avec extension Markdown
  • Typora : Éditeur Markdown WYSIWYG
  • Vim/Neovim : Avec plugins Markdown

Validation

  • Markdown lint : Vérification syntaxe
  • Prettier : Formatage automatique
  • GitHub : Prévisualisation en ligne

📋 Checklist pour nouvelle documentation

  • Structure claire avec sections logiques
  • Exemples de code fonctionnels
  • Commandes testées
  • Configuration complète
  • Dépannage et FAQ
  • Liens vers ressources externes
  • Mise à jour du README principal

🤝 Contribution

Pour ajouter ou modifier la documentation :

  1. Créer une branche : git checkout -b docs/nom-du-systeme
  2. Rédiger : Suivre les conventions ci-dessus
  3. Tester : Vérifier les exemples et commandes
  4. Commiter : Message descriptif
  5. Pull Request : Description des changements

📞 Support

Pour toute question sur la documentation :

  • Consulter les exemples de code
  • Vérifier la configuration
  • Tester les commandes
  • Ouvrir une issue si nécessaire