Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- MicroPython
- Rédacteur technique:
- Joannah Nanjekye
- Nom du projet:
- Documenter les composants internes de MicroPython
- Durée du projet:
- Durée standard (3 mois)
Project description
Abstraite
MicroPython est une autre implémentation du langage de programmation Python. Il est destiné à être principalement compatible avec Python 3.4, mais il possède un sous-ensemble de certaines fonctionnalités, en particulier les types de données et les modules. MicroPython est un outil simple et efficace, qui peut être exécuté sur des microcontrôleurs et des environnements à ressources limitées[1]. Le projet est open source et a attiré de nombreux utilisateurs et contributeurs au fil du temps. La documentation du projet favorisera la croissance des utilisateurs, mais également celle des contributeurs de nouvelles fonctionnalités. La contribution à MicroPython implique généralement de travailler sur la durée d'exécution principale, le portage vers un nouveau tableau ou système d'exploitation, ou la maintenance d'une nouvelle bibliothèque. Cette proposition se concentre sur la documentation des composants internes du projet MicroPython. Les principaux thèmes sont le fonctionnement interne de l'interprète lui-même, le portage du langage sur une nouvelle plateforme et la création d'un nouveau module.
Vue d'ensemble sur les projets
Le projet vise à ajouter la documentation sur les composants internes de MicroPython au fichier docs.micropython.org déjà établi. Nous pouvons également déplacer cela vers internals.micropython.org. À partir des commentaires de la communauté, l'un des mentors, Jim Mussared, nous a conseillé de déplacer cette documentation dans une section « Développer ». L'objectif est de traiter les détails de MicroPython du point de vue d'un développeur, qui travaille sur l'implémentation de MicroPython. Cela conduira à une courbe de contribution douce pour toute personne souhaitant s'impliquer dans le projet.