MicroPython project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project aims to create comprehensive documentation of MicroPython's internal workings, focusing on the interpreter, porting to new platforms, and module creation."],["The documentation will be integrated into the existing MicroPython documentation site, potentially under a dedicated \"develop\" section, to enhance accessibility for developers."],["By providing clear and detailed information on the internals, the project aims to simplify the contribution process and attract more developers to the MicroPython project."],["MicroPython is an efficient and lean implementation of Python 3.4, designed for microcontrollers and resource-constrained environments."]]],["The project, \"Document the Internals of MicroPython,\" accepted for Google Season of Docs, aims to enhance the MicroPython documentation. The focus will be on the inner workings of the interpreter, porting the language, and module creation. The documentation will target developers working on MicroPython's implementation, with the goal of creating a smoother process to get involved in the project. The new information will be located in the 'develop' section of the documentation.\n"]]
