Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to the website #197

Open
ckugel opened this issue May 16, 2024 · 1 comment
Open

Add documentation to the website #197

ckugel opened this issue May 16, 2024 · 1 comment

Comments

@ckugel
Copy link

ckugel commented May 16, 2024

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?

@ckugel ckugel closed this as completed May 16, 2024
@ikskuh ikskuh reopened this May 17, 2024
@ikskuh
Copy link
Contributor

ikskuh commented May 17, 2024

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 :)

@ikskuh ikskuh changed the title Github hosted static site for docs Add documentation to the website May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants