You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current crates are fairly straightforward, and are easy to understand from the comments in code and examples. The guide will be more relevant once complex, interacting crates are included.
The guide is pretty much empty. It should have something in it.
Straw proposal:
Make every gloo crate use
cargo readme
to generate itsgloo/crates/whatever/README.md
from its module documentationUse
mdbook
's file include feature to include these as a section in the guideThis would get us a good amount of documentation in all the places users expect it to be, without multiplying the maintenance effort.
Thoughts?
+cc @David-OConnor @Pauan @yoshuawuyts @rylev
The text was updated successfully, but these errors were encountered: