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

Host Cargo Documentation #4

Open
SpikeHD opened this issue Mar 26, 2024 · 5 comments
Open

Host Cargo Documentation #4

SpikeHD opened this issue Mar 26, 2024 · 5 comments

Comments

@SpikeHD
Copy link
Contributor

SpikeHD commented Mar 26, 2024

Documentation for the library can be automatically generated with cargo doc, so it'd be neat to see it hosted somewhere. Something like rust.webui.me would be cool, but GitHub Pages would be fine too.

@jinzhongjia
Copy link
Collaborator

I host the zig doc on github page ,https://webui-dev.github.io/zig-webui/

@jinzhongjia
Copy link
Collaborator

Maybe we should improve the rust documentation hosted on webui.me?
I believe many people will check here first.

@AlbertShown
Copy link
Contributor

The auto docs generator are in my opinion simple and basic, they just give a list of detected function and the comments above... while a manual written documentation give more explanation and details, so, I suggest focusing on improving the manual docs.

@SpikeHD
Copy link
Contributor Author

SpikeHD commented Mar 27, 2024

Oh yea, the cargo docs are pretty limited right now (and can/should be improved), but they're also a pretty standard thing to have available. I'll try to remember to update the Rust docs on webui-dev/website soon since I agree that should be a priority, but I think both should exist just like how the Zig documentation exists.

@AlbertShown
Copy link
Contributor

Sure, The main docs are in https://webui.me/docs/2.4/#/, we can put the Rust docs at https://webui.me/docs/rust.
Later, someone can creating a subdomain rust.webui.me and point it to that folder webui.me/docs/rust.

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

3 participants