ZigEmbeddedGroup / microzig

Unified abstraction layer and HAL for several microcontrollers
zlib License
1.05k stars 79 forks source link

Add documentation to the website #197

Open ckugel opened 1 month ago

ckugel commented 1 month ago

A documentation page for this repo would be very helpful for new embedded programmers who want to get into embedded development with Zig. I would be very willing to aid in a project for making a static site on github of all the documentation, maybe in a javadocs style of documentation. Would this be a feature that people would want? Would there be other people willing to aid in this project?

ikskuh commented 1 month ago

We should definitly add a proper hosted documentation of MicroZig, right now it's not really well-done. The website repository is in the monorepo now, but isn't updated anymore.

I would like to see both documentation and a set of supported devices and boards on the website, so this ticket stays open :)