Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- MicroPython
- Escritor técnico:
- Joannah Nanjekye
- Nombre del proyecto:
- Documenta los aspectos internos de MicroPython
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Se puede abstraer
MicroPython es una implementación alternativa del lenguaje de programación Python. Su objetivo es ser más compatible con Python 3.4, pero tiene un subconjunto de algunas de las funcionalidades, en especial, los tipos de datos y los módulos. MicroPython es ligero y eficiente para ejecutarse en microcontroladores y entornos con recursos limitados [1]. El proyecto es de código abierto y ha atraído a muchos usuarios y colaboradores con el tiempo. Documentar el proyecto fomentará un mayor crecimiento en los usuarios, pero también los colaboradores de nuevas funciones. Por lo general, contribuir a MicroPython implica trabajar en el tiempo de ejecución principal, realizar la portabilidad a una placa o sistema operativo nuevos, o mantener una biblioteca nueva. Esta propuesta se centra en la documentación de los componentes internos del proyecto de MicroPython. Los temas principales son el funcionamiento interno del propio intérprete, la portabilidad del lenguaje a una nueva plataforma y la creación de un módulo nuevo.
Detalles del proyecto
El objetivo del proyecto es agregar documentación interna de MicroPython al archivo docs.micropython.org ya establecido. También podemos moverlo a internals.micropython.org. A partir de los comentarios de la comunidad, uno de los mentores, Jim Mussared, nos recomendó que traslademos esta documentación a una sección de “desarrollo”. El objetivo es cubrir los detalles de MicroPython desde la perspectiva de un desarrollador, trabajando en la implementación de MicroPython. Esto provocará una curva de contribución suave para quienes quieran participar en el proyecto.