Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- MicroPython
- Redattore tecnico:
- Giorgia Nanjekye
- Nome del progetto:
- Documentare le parti interne di MicroPython
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Abstract
MicroPython è un'implementazione alternativa del linguaggio di programmazione Python. Ha lo scopo di essere compatibile per la maggior parte con Python 3.4, ma ha un sottoinsieme di alcune funzionalità, in particolare tipi di dati e moduli. L'esecuzione su microcontroller e in ambienti con risorse limitate da risorse è un po' snello ed efficiente. Il progetto è open source e ha attirato molti utenti e collaboratori nel tempo. La documentazione del progetto favorirà una maggiore crescita degli utenti, ma anche dei collaboratori delle nuove funzionalità. Collaborare a MicroPython di solito comporta lavorare sul runtime di base, sul porting a una nuova scheda/sistema operativo o sulla manutenzione di una nuova libreria. Questa proposta si concentra sulla documentazione degli aspetti interni del progetto MicroPython. I temi principali sono il funzionamento interno dell'interprete stesso, il porting del linguaggio a una nuova piattaforma e la creazione di un nuovo modulo.
Dettagli dei progetti
Lo scopo del progetto è aggiungere la documentazione interna di MicroPython a quella già esistente su docs.micropython.org. Possiamo spostarlo anche su internals.micropython.org. In base al feedback della community, uno dei mentor, Jim Mussared, ci ha consigliato di spostare questa documentazione in una sezione "sviluppo". L'obiettivo è esaminare i dettagli di MicroPython dal punto di vista di uno sviluppatore, lavorando all'implementazione di MicroPython stesso. In questo modo, chiunque voglia partecipare al progetto produrrà una leggera curva di contributo.