mirror of
https://github.com/bevyengine/bevy
synced 2024-11-21 20:23:28 +00:00
cbe13f3aa5
# Objective This PR continues https://github.com/bevyengine/bevy/pull/8885 It aims to improve the `Mesh` documentation in the following ways: - Put everything at the "top level" instead of the "impl". - Explain better what is a Mesh, how it can be created, and that it can be edited. - Explain it can be used with a `Material`, and mention `StandardMaterial`, `PbrBundle`, `ColorMaterial`, and `ColorMesh2dBundle` since those cover most cases - Mention the glTF/Bevy vocabulary discrepancy for "Mesh" - Add an image for the example - Various nitpicky modifications ## Note - The image I added is 90.3ko which I think is small enough? - Since rustdoc doesn't allow cross-reference not in dependencies of a subcrate [yet](https://github.com/rust-lang/rust/issues/74481), I have a lot of backtick references that are not links :( - Since rustdoc doesn't allow linking to code in the crate (?) I put link to github directly. - Since rustdoc doesn't allow embed images in doc [yet](https://github.com/rust-lang/rust/issues/32104), maybe [soon](https://github.com/rust-lang/rfcs/pull/3397), I had to put only a link to the image. I don't think it's worth adding [embed_doc_image](https://docs.rs/embed-doc-image/latest/embed_doc_image/) as a dependency for this. |
||
|---|---|---|
| .. | ||
| android-res/mipmap-mdpi | ||
| branding | ||
| data | ||
| docs | ||
| environment_maps | ||
| fonts | ||
| models | ||
| pixel | ||
| scenes | ||
| shaders | ||
| sounds | ||
| textures | ||