Migration de la documentation de TradingInPython
Ce matin, je demande à mon #IA :
Pour le logiciel TradingInPython j'ai trois systèmes de documentation,
Blogger : https://www.trading-et-data-analyses.com/p/plateforme-de-trading-technique.html
MkDocs avec https://mabyre.github.io/TradingInPython-doc/ et un
Wiki avec https://github.com/SoDevLog/PyTrading/wiki Et je ne sais pas lequel choisir
Voici sa réponse à laquelle je m'attendais un peu :
Pour un projet comme TradingInPython, MkDocs est généralement le meilleur choix si tu veux une documentation technique bien structurée, évolutive et facile à maintenir.
Voici une comparaison détaillée des trois options pour t’aider à décider :
🧰 1. MkDocs (https://mabyre.github.io/TradingInPython-doc/)
✅ Avantages :
- Spécialement conçu pour la documentation technique : basé sur Markdown, avec navigation claire et hiérarchie des pages.
- Facile à versionner avec Git et à héberger sur GitHub Pages.
- Personnalisable avec des thèmes (comme Material for MkDocs) et des plugins.
- Bonne lisibilité et ergonomie pour les développeurs et utilisateurs techniques.
❌ Inconvénients :
- Nécessite un peu de configuration initiale (fichier
mkdocs.yml, structure des dossiers). - Moins adapté aux articles de blog ou contenu non technique.
📝 2. GitHub Wiki (https://github.com/SoDevLog/PyTrading/wiki)
✅ Avantages :
- Intégré à GitHub : facile à modifier en ligne, bon pour les contributions communautaires.
- Markdown natif et versionné avec le dépôt.
- Rapide à mettre en place sans configuration.
❌ Inconvénients :
- Moins flexible en termes de design et navigation.
- Pas de support natif pour les thèmes ou plugins.
- Moins professionnel pour une documentation publique ou commerciale.
📚 3. Blogger (https://www.trading-et-data-analyses.com/p/plateforme-de-trading-technique.html)
✅ Avantages :
- Idéal pour du contenu éditorial : articles, tutoriels, annonces.
- Facile à gérer sans compétences techniques.
- Bon référencement naturel (SEO) pour attirer du trafic.
❌ Inconvénients :
- Pas conçu pour la documentation technique : navigation peu intuitive, pas de structure hiérarchique.
- Difficile à maintenir pour des mises à jour fréquentes ou collaboratives.
- Pas de versionnement ou intégration Git.
🧭 Recommandation
- Utilise MkDocs comme documentation principale : claire, technique, bien structurée.
- Complète avec Blogger pour les articles de vulgarisation, tutoriels ou annonces.
- Utilise le Wiki GitHub pour les contributions communautaires ou notes internes.
Tu peux même intégrer des liens croisés entre les trois pour créer un écosystème cohérent. Si tu veux, je peux t’aider à structurer ta doc MkDocs ou à créer un plan de migration.
La documentation TradingInPython va donc migrer vers MkDocsJ'espère que ça vous plaira.
N'hésitez pas à me faire vos remarques.
Commentaires
Enregistrer un commentaire
Merci pour votre commentaire.
S'il n'apparaît pas tout de suite c'est qu'il est en attente de modération.
Merci de votre compréhension.