webui-dev / rust-webui

Use any web browser or WebView as GUI, with Rust in the backend and modern web technologies in the frontend, all in a lightweight portable library.
https://webui.me/
MIT License
27 stars 8 forks source link

Host Cargo Documentation #4

Open SpikeHD opened 8 months ago

SpikeHD commented 8 months ago

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 commented 8 months ago

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

jinzhongjia commented 8 months ago

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

AlbertShown commented 8 months ago

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 commented 8 months ago

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 commented 8 months ago

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.