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

Include READMEs from Bevy crates as crate-level documentation #2566

Closed
alice-i-cecile opened this issue Jul 29, 2021 · 2 comments
Closed

Include READMEs from Bevy crates as crate-level documentation #2566

alice-i-cecile opened this issue Jul 29, 2021 · 2 comments
Labels
C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

With the release of Rust 1.54, we can now do this:

#![doc = include_str!("README.md")]

This is great, because we have useful content in our READMEs that should be in our module-level documentation, rather than buried several levels deep on Github.

Some crates already have existing module-level description; for the most part this should be consolidated into the readme. bevy itself is the only exception that comes to mind; it's probably worth including some advice on contributing / navigating Github that doesn't make sense on docs.rs.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy labels Jul 29, 2021
@cart
Copy link
Member

cart commented Jul 29, 2021

As a counter point: this optimizes for "github browsing" workflows, which actual bevy developers won't do much. It creates a level of indirection for people who are actually working in the code. Docs that would have been available directly in the mod file currently being worked on are now somewhere else in the tree.

I like this for "crate level" documentation because it allows us to reuse README content we'd need to write anyway (when that is desirable), but I'm not convinced that this is a win for nested modules.

@alice-i-cecile
Copy link
Member Author

I like this for "crate level" documentation because it allows us to reuse README content we'd need to write anyway (when that is desirable), but I'm not convinced that this is a win for nested modules.

Yes, my intent was to only include this for top-level crates ala bevy_ecs. My bad on the title; I'll make it more clear.

@alice-i-cecile alice-i-cecile changed the title Include READMEs from Bevy crates as module-level documentation Include READMEs from Bevy crates as crate-level documentation Jul 29, 2021
@bors bors bot closed this as completed in e018ac8 Dec 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants