Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- MicroPython
- Rédacteur technique:
- Joannah Nanjekye
- Nom du projet:
- Documenter les éléments internes de MicroPython
- Durée du projet:
- Durée standard (3 mois)
Project description
Extrait
MicroPython est une autre implémentation du langage de programmation Python. Il est conçu pour être principalement compatible avec Python 3.4, mais il comporte un sous-ensemble de certaines fonctionnalités, en particulier les types de données et les modules. MicroPython est léger et efficace à exécuter sur les microcontrôleurs et les environnements à ressources limitées [1]. Ce projet Open Source a attiré de nombreux utilisateurs et contributeurs au fil du temps. La documentation du projet favorisera l'augmentation du nombre d'utilisateurs, mais aussi de contributeurs de nouvelles fonctionnalités. Contribuer à MicroPython implique généralement de travailler sur l'environnement d'exécution principal, le portage vers une nouvelle carte/un nouveau système d'exploitation ou la maintenance d'une nouvelle bibliothèque. Cette proposition se concentre sur la documentation des éléments internes du projet MicroPython. Les thèmes principaux sont le fonctionnement interne de l'interprète lui-même, le portage de la langue vers une nouvelle plate-forme et la création d'un nouveau module.
Détails du projet
Le projet vise à ajouter la documentation interne de MicroPython à la documentation déjà établie sur docs.micropython.org. Nous pouvons également le déplacer vers internals.micropython.org. Suite aux commentaires de la communauté, l'un des mentors, Jim Mussared, nous a conseillé de placer cette documentation dans une section "Développement". L'objectif est d'aborder les détails relatifs à MicroPython du point de vue d'un développeur, en travaillant sur l'implémentation de MicroPython proprement dit. Cela permettra à tous ceux qui souhaitent s'impliquer dans le projet de le faire progressivement.