Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- MicroPython
- Redactor técnico:
- Joannah Nanjekye
- Nombre del proyecto:
- Documentar los componentes internos de MicroPython
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Resumen
MicroPython es una implementación alternativa del lenguaje de programación Python. Su objetivo es ser compatible en su mayoría con Python 3.4, pero tiene un subconjunto de algunas de las funciones, en especial los tipos de datos y los módulos. MicroPython es eficiente y ágil para ejecutarse en microcontroladores y entornos con recursos limitados [1]. El proyecto es de código abierto y atrajo a muchos usuarios y colaboradores con el tiempo. Documentar el proyecto fomentará un mayor crecimiento de los usuarios, pero también de los colaboradores de nuevas funciones. Contribuir a MicroPython suele implicar trabajar en el tiempo de ejecución principal, portar a una nueva placa o sistema operativo, o mantener una biblioteca nueva. Esta propuesta se centra en la documentación de los elementos internos del proyecto MicroPython. Los temas principales son el funcionamiento interno del 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 a docs.micropython.org, que ya está establecida. También podemos moverlo a internals.micropython.org. A partir de los comentarios de la comunidad, uno de los mentores, Jim Mussared, nos aconsejó que traslademos esta documentación a una sección “Desarrollo”. El objetivo es abordar los detalles de MicroPython desde la perspectiva de un desarrollador que trabaja en la implementación de MicroPython. Esto generará una curva de contribución suave para cualquiera que quiera participar en el proyecto.