Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Emitting docs for microzig

Aperta
  • Qualcosa non va?
#460 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
Più di una settimana
Idoneità per principianti
22/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
embedded-iot
Ambito
documentation

Direzione di ricerca

This is a tracking issue with several separate tasks, so pick one checkbox rather than the whole list. The payload names docs/design.md for moving to the website, and the note about hal.zig sitting outside the hal directory, which breaks doc generation and produces names like hal.hal.clocks. Done means one concrete task is finished and the docs build without the duplicated prefix. Nothing shows a current maintainer reply, so confirm scope before starting.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Emitting docs for microzig

Issue for tracking microzig docs. Please feel free to add more things that you feel microzig is curently lacking in terms of documentation.

  • Emitting zig docs for firmware (for everything in the app and in microzig)
  • Emitting zig docs for everything microzig (core, drivers, ports). These could also be published to the website.
    • perhaps this can be done using a dummy firmware (maybe having a long introductory comment) and Firmware.get_emitted_docs() this works only for one port/target
  • Update and move docs/design.md to the website
  • Website build system documentation (including what ports are available)
  • Website tour of microzig

** Some hals have the hal.zig file moved outside of the hal directory. This messes with the generation of docs and creates strange names like hal.hal.clocks. Moving hal.zig (the root source file of the hal) inside the hal directory gets rid of this issue.

Lingua principale
Zig
Stelle
2.3k
Fork
198
Merge medio
1g 8h
PR unite (30g)
37

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ZigEmbeddedGroup/microzig

Tutte le issue di ZigEmbeddedGroup/microzig

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.