Reorganize

.github/workflows/documentation.yaml

@@ -1,7 +1,14 @@
 # From: https://github.com/rkdarst/sphinx-actions-test/blob/master/.github/workflows/sphinx-build.yml
 name: Sphinx
 
-on: [push, pull_request, workflow_dispatch]
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the main branch
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
 
 # If these SPHINXOPTS are enabled, then be strict about the builds and
 # fail on any warnings

content/index.rst

@@ -1,10 +1,9 @@
 .. _mk2pvrouter:
 
-************************************************
 Bienvenue dans la documentation du Mk2PVRouter !
-************************************************
+================================================
 
-| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation.
+| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation.
 |
 | Particulièrement adapté à l’alimentation de résistances (chauffe-eau, radiateur, sol chauffant) du fait de son alimentation à puissance variable, il saura orienter votre surplus vers le ou les équipements raccordés.
 |
@@ -46,7 +45,7 @@ Bienvenue dans la documentation du Mk2PVRouter !
 .. toctree::
    :hidden:
 
-   introduction.md
+   introduction
 
 .. toctree::
    :maxdepth: 3

content/introduction.rst

@@ -0,0 +1,87 @@
+.. _introduction:
+
+Introduction
+============
+
+| Cette documentation est applicable à toutes les versions du Mk2PVRouter, qu'elles soient monophasées ou triphasées.
+| La majorité des informations sont pertinentes pour les deux versions.
+| Chaque version a son propre chapitre.
+
+Contenu du kit
+--------------
+
+Dans le kit, vous trouverez :
+
+* le circuit imprimé ({term}`PCB`) de la carte-mère
+* un ou plusieurs circuits imprimés pour chaque sortie
+* des composants électroniques (résistances, condensateurs, …).
+  Attention, certains sont sensibles à l'électricité statique, il faut donc les manipuler avec soin.
+* un boîtier
+* des câbles
+
+
+Étapes d'assemblage
+-------------------
+
+L'assemblage complet va nécessiter plusieurs étapes :
+
+* soudure et tests de la carte-mère
+* soudure et tests de la ou les cartes de sortie
+* perçage du boîtier
+* perçage du ou des dissipateurs thermiques
+* montage des circuits soudés dans le boîtier
+* confection des câbles
+* câblage
+* étalonnage
+* programmation finale
+
+Recommandations pour les étapes de soudure
+------------------------------------------
+
+| Les composants nécessaires sont très variés. Certains sont passifs (comme les résistances), tandis que d'autres sont actifs (comme l'AtMega328P).
+| Tous ces composants sont généralement sensibles à l'électricité statique.
+| Il est donc important de les manipuler avec soin et, si possible, de se mettre à la terre pour éviter toute décharge électrostatique.
+
+Certains composants sont polarisés (comme les diodes et certains condensateurs), tandis que d'autres ne le sont pas (comme les résistances et certains condensateurs). Il est donc crucial de faire attention à l'orientation des composants AVANT de les souder. L'orientation est généralement indiquée directement sur la carte mère.
+
+Les composants varient également en taille, allant de quelques millimètres à plusieurs centimètres (dans le cas des transformateurs).
+
+Pour des raisons pratiques, il est recommandé de procéder à la soudure en suivant un ordre précis basé sur la taille des composants.
+
+Ainsi, l'ordre de soudure recommandé est le suivant :
+#. Résistances et diodes, et éventuellement les ponts
+#. Supports IC1 et IC2 (et éventuellement IC3, IC4 selon le kit) (ne pas insérer les circuits intégrés dans les supports à ce stade)
+#. Condensateurs non polarisés "orange", oscillateur
+#. Pont·s de diodes
+#. Tous les connecteurs SIL noirs et le connecteur d'affichage, le cas échéant
+#. Condensateurs polarisés (noirs ou bleus)
+#. Le socle pour l'antenne, le cas échéant
+#. Les gros connecteurs "haute tension"
+#. Les porte-fusibles
+#. Les régulateurs de tension
+#. Enfin, les transformateurs
+
+Suivre cette séquence précise permet d'éviter de tordre les pattes des composants ou d'avoir à utiliser de l'adhésif, entre autres.
+
+Matériels/outils nécessaires
+----------------------------
+
+* fer à souder
+* fil de soudure
+* pince coupante
+* pince à sertir les cosses ou pince multifonction
+* tournevis cruciforme
+* clé plate ou douille de **5,5**
+* clé plate de **10**
+* clé six pans de **2** et **2,5**
+* une perceuse à colonne si possible, sinon n'importe quelle perceuse.
+* foret métal de **3 mm**
+* foret métal de **4 mm**
+* foret (bois ou métal) de **8 mm**
+* foret (bois ou métal) ou fraise de **20 mm**
+* fraise de **35 mm**
+* colle thermofusible
+* gaine thermorétractable
+* multimètre (au minimum voltmètre et ohmmètre)
+
+Certains matériels sont optionnels (fraise de 35, colle, gaine). Cependant, ils faciliteront certaines étapes et permettront de réaliser un travail plus soigné et bien fini.

content/mk2pvrouter.rst

@@ -0,0 +1,13 @@
+.. _mk2pvrouter:
+
+Qu'est-ce qu'un routeur ?
+=========================
+
+| Le régulateur de puissance ou **routeur solaire** permet d'optimiser l'autoconsommation de votre installation Photovoltaïque.
+| Il détecte l'excédent d'électricité produit par vos panneaux photovoltaïques, et l'utilise pour alimenter différents appareils électriques.
+| Un routeur solaire peut activer ces différents appareils comme la résistance de votre chauffe-eau, la station de recharge de votre voiture, la pompe à chaleur…
+
+| Le MK2 PV Router est l’accessoire indispensable lorsque l’on souhaite optimiser son autoconsommation.
+|
+| Particulièrement adapté à l’alimentation de résistances (chauffe-eau, radiateur, sol chauffant) du fait de son alimentation à puissance variable, il saura orienter votre surplus vers le ou les équipements raccordés.
+|