Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- MicroPython
- Pisarz techniczny:
- Joanna Nanjekye
- Nazwa projektu:
- Dokumentacja wewnętrzna MicroPythona
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Streszczenie
MicroPython to alternatywna implementacja języka programowania Python. Ma być w dużej mierze zgodna z Pythonem 3.4, ale zawiera podzbiór niektórych funkcji, zwłaszcza typów danych i modułów. MicroPython nie wymaga dużych nakładów pracy i działa na mikrokontrolerach i środowiskach z ograniczonymi zasobami [1]. Projekt jest typu open source i z czasem przyciągnął wielu użytkowników i współtwórców. Udokumentowanie projektu zachęci więcej użytkowników do korzystania z niego, a także do tworzenia nowych funkcji. Współtworzenie MicroPython zwykle polega na pracy nad głównym środowiskiem wykonawczym, przenoszeniu na nową płytkę lub system operacyjny albo na utrzymaniu nowej biblioteki. Ta propozycja koncentruje się na dokumentacji wewnętrznej projektu MicroPython. Główne tematy to wewnętrzne działanie samego tłumacza, przenoszenie języka na nową platformę i tworzenie nowego modułu.
Szczegóły projektu
Celem projektu jest dodanie dokumentacji wewnętrznej MicroPython do już istniejącej strony docs.micropython.org. Możemy też przenieść to na stronę Internals.micropython.org. Na podstawie opinii społeczności jeden z mentorów, Jim Mussared, zasugerował przeniesienie tej dokumentacji do sekcji „Rozwijanie”. Celem jest omówienie szczegółów mikroPythona z perspektywy programisty oraz pracy nad wdrożeniem samego mikroPythona. Dzięki temu osoby, które chcą wziąć udział w projekcie, będą mogły robić to stopniowo.