Emitting docs for microzig
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 22/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- embedded-iot
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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) andthis works only for one port/targetFirmware.get_emitted_docs()
- 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.
- Langage dominant
- Zig
- Étoiles
- 2.3k
- Forks
- 198
- Merge moyen
- 1 j 8 h
- PR mergées (30 j)
- 37
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de ZigEmbeddedGroup/microzig
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
ZigEmbeddedGroup/microzig#1086 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 69/100
ZigEmbeddedGroup/microzig#1085 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
ZigEmbeddedGroup/microzig#1061 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
ZigEmbeddedGroup/microzig#1059 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
regz: AVR peripherals generated at address 0 when the register-group name matches the module (ATDF)Peut-être pris Une pull request liée à cette issue est ouverte ou déjà fusionnée. Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
ZigEmbeddedGroup/microzig#1072 ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de ZigEmbeddedGroup/microzig
Issues similaires
-
documentation good first issue
Difficulté 2/5 Une demi-journée Accessibilité débutants 72/100
sujithputta02/Esapay#13 ·
-
good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
saayam-for-all/webapp#1919 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
Uuriko/project-room#3728 ·
Les mainteneurs répondent en général sous 1 jour
-
docs(site): Mermaid edge-label contrast on Architecture and a table header on How it comparesOuvertedocumentation
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
devops-thiago/ThrillhouseBot#1132 ·
Les mainteneurs répondent en général sous 1 jour
-
Old package name @routedock/sdk is still used in JSDoc, test run instructions and docsPeut-être pris @TS-mfon l’a pris aujourd’hui. Ouvertedocs dx P2 Stellar Wave Wave 10
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
winsznx/routedock#576 · 5 commentaires ·
Les mainteneurs répondent en général sous 1 jour