Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- MicroPython
- Redator técnico:
- Joannah Nanjekye
- Nome do projeto:
- Documentar os componentes internos do MicroPython
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Com abstração
MicroPython é uma implementação alternativa da linguagem de programação Python. Ele pretende ser compatível principalmente com o Python 3.4, mas tem um subconjunto de algumas funcionalidades, especialmente tipos de dados e módulos. O MicroPython é enxuta e eficiente para execução em microcontroladores e ambientes com recursos limitados [1]. O projeto é de código aberto e tem atraído muitos usuários e colaboradores ao longo do tempo. Documentar o projeto incentivará mais o crescimento dos usuários, mas também contribuirá para novos recursos. Contribuir com o MicroPython geralmente envolve trabalhar no tempo de execução principal, fazer a portabilidade para uma nova placa/sistema operacional ou manter uma nova biblioteca. Esta proposta se concentra na documentação dos componentes internos do projeto MicroPython. Os principais temas são o funcionamento interno do próprio intérprete, a portabilidade do idioma para uma nova plataforma e a criação de um novo módulo.
Detalhes do projeto
O projeto visa adicionar a documentação interna do MicroPython ao docs.micropython.org já estabelecido. Também podemos movê-lo para internals.micropython.org. Com base no feedback da comunidade, um dos mentores, Jim Mussared aconselhou que transferirmos essa documentação para uma seção de desenvolvimento. O objetivo é abordar os detalhes do MicroPython da perspectiva de um desenvolvedor, trabalhando na implementação do próprio MicroPython. Isso levará a uma curva de contribuição suave para qualquer pessoa que queira se envolver no projeto.