lborb / book

The Little Book of Rust Books
https://lborb.github.io/book/
MIT License
291 stars 44 forks source link

Add a Documentation Library section #75

Open tcodebk opened 8 months ago

tcodebk commented 8 months ago

A fourth section could be appended to the current structure which would include the reference documentation for select crates such as is found here: crossbeam docs.

This could be used to fill-in for crates associated with the mdbooks from the prior sections.

For example there are mdbooks linked which involve crossbeam.rs so a link to the documentation could be included in a new Documentation Library section.

Similar to an appendices ie. Appendix A: Associated Documentation Library.

glyn commented 8 months ago

I'm not sure this adds a lot of value and would increase the effort of maintaining the book. Are there not good ways to search for known crate docs? E.g. searching for "crossbeam crate docs" in DuckDuckGo gives the crate docs as the first hit.

Also, I wouldn't put this in a separate section. I'd probably just add a "(crate)" link on the end of the description for ease of maintenance.

tcodebk commented 8 months ago

In the cases where the document is closely related to a single crate. Adding a "(crate)" link at the end of the description seems helpful.

glyn commented 8 months ago

How many of the existing entries would this apply to? Would you be interested in becoming a committer in this repo to lend a hand?

Tbkhi commented 8 months ago

I think it would only apply to a few entries. Just the ones which are explicitly related to a particular crate. Such as the documentation around crossbeam.