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 a Documentation Library section #75

Open
tcodebk opened this issue Jan 6, 2024 · 3 comments
Open

Add a Documentation Library section #75

tcodebk opened this issue Jan 6, 2024 · 3 comments

Comments

@tcodebk
Copy link
Contributor

tcodebk commented Jan 6, 2024

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
Copy link
Contributor

glyn commented Jan 7, 2024

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
Copy link
Contributor Author

tcodebk commented Jan 7, 2024

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
Copy link
Contributor

glyn commented Jan 8, 2024

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
Copy link
Contributor

Tbkhi commented Jan 19, 2024

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.

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