Vous pouvez contribuer à la documentation utilisateur de Papillon via ce dépôt GitHub.
Cette documentation est encore en cours de rédaction, et pas encore déployée.
Le contenu du site est écrit en Markdown et se trouve dans /docs.
Le site web est ensuite généré par MkDocs avec le modèle Material for MkDocs.
Vous pouvez vous aider de la référence de Material for MkDocs.
Forkez ce dépôt, faites vos propositions et envoyez une pull request. On l'acceptera au plus vite. Merci de séparer toutes vos modifications dans des commits différents.
Pour tester vos changements sur votre ordinateur avant l'envoi:
- Installez Python
- Sur Windows, cochez l'option pour ajouter Python au PATH lors de l'installation
- Clonez le référentiel et ouvrez un terminal dans le dossier du clone
- Installez les outils nécessaires avec:
pip3 install -r requirements.txt- Démarrez un serveur compilant automatiquement les modifications :
mkdocs serve