This page contains the details of a technical writing project accepted for Season of Docs.
Project summary
- Open source organization:
- MicroPython
- Technical writer:
- Joannah Nanjekye
- Project name:
- Document the Internals of MicroPython
- Project length:
- Standard length (3 months)
Project description
Abstract
MicroPython is an alternate implementation of the Python programming language. It is aimed to be mostly compatible with Python 3.4 but has a subset of some of the functionality, especially data types and modules. MicroPython is lean and efficient to run on microcontrollers and resource-constrained environments [1]. The project is open source and has attracted many users and contributors over time. Documenting the project will foster more growth in users but also contributors of new features. Contributing to MicroPython usually involves working on either the core run time, porting to a new board/operating system, or maintaining a new library. This proposal focuses on the documentation of the internals of the MicroPython project. The major themes being the inner workings of the interpreter itself, porting the language to a new platform, and creating a new module.
Project Details
The project aims at adding MicroPython internals documentation to the already established docs.micropython.org. We can move this to internals.micropython.org too. From community feedback, one of the mentors, Jim Mussared advised we move this documentation under a “develop” section. The goal is to cover MicroPython details from the perspective of a developer, working on the implementation of MicroPython itself. This will lead to a gentle contribution curve for anyone looking to get involved in the project.