🤝 Contribuer au dépôt¶

Ce dépôt est collaboratif : il regroupe des tutoriels, exemples de code et fiches techniques pour les composants électroniques utilisés en Bac Pro et BTS CIEL.
Chacun peut contribuer en ajoutant un nouveau composant, en améliorant la documentation ou en partageant des exemples.

🧩 Convention de nommage¶

Pour garder une structure claire et homogène :

🆕 Ajouter un composant¶

1. Copier le squelette :

   cp -r templates/component_skeleton composants/<nom_du_composant>
   

2. Compléter les fichiers Markdown :

3. README.md : présentation générale du composant
4. tuto_1_*.md, tuto_2_*.md : tutoriels pas à pas

5. references.md : fiches techniques, liens, documentation fabricant

6. Créer au moins un exemple fonctionnel dans code/ :

7. Projet PlatformIO compilable

8. Inclure un fichier platformio.ini et un dossier src/ contenant le code (.ino, .cpp, etc.)

9. Ajouter le composant à la navigation dans mkdocs.yml :

   nav:
     - Composants:
         - Heltec WiFi LoRa 32 V3: composants/heltec_wifi_lora_32_v3/README.md
   

🗂️ Structure type d’un composant¶

composants/
└── heltec_wifi_lora_32_v3/
    ├── README.md
    ├── tuto_1_meshtastic.md
    ├── tuto_2_lora-sans-meshtastic.md
    ├── references.md
    ├── code/
    │   ├── platformio.ini 
    │   └── src/
    │       └── LoRaReceiver.ino
    └── images/
        └── heltec_wifi_lora_32_v3.png

🧱 Générer et visualiser la documentation en local¶

🔧 Installation des outils¶

# Installer Python et pip
sudo apt update
sudo apt install python3 python3-pip -y

# Installer MkDocs et les extensions utilisées
pip3 install mkdocs-material mkdocs-include-markdown-plugin mkdocs-exclude

🪄 Génération automatique des pages¶

Chaque fois que vous ajoutez un composant, exécutez :

python ./synchro_docs.py

Cela met à jour la documentation à partir des fichiers présents dans composants/.

🌐 Visualiser le site en local¶

mkdocs serve

Le site est alors accessible sur :
➡️ http://127.0.0.1:8000/

⚖️ Licences¶

• Code source : CeCILL-B
• Documentation et tutoriels : CC-BY-NC-SA 4.0

✍️ Merci à tous les contributeurs !
Votre participation permet d’enrichir ce dépôt et de le rendre utile à toute la communauté CIEL.