bevy/crates/bevy_asset/src
Alice Cecile 23aca13609
Add module and supporting documentation to bevy_assets (#15056)
# Objective

Bevy's asset system is powerful and generally well-designed but very
opaque.

Beginners struggle to discover how to do simple tasks and grok the
fundamental data models, while more advanced users trip over the
assorted traits and their relation to each other.

Reverts #15054 ;)

## Solution

This PR adds module documentation to `bevy_assets`, tweaking the
associated documentation on the items as needed to provide further
details and bread crumbs.

If you have ideas for other important, hard-to-discover patterns or
functionality in this crate, please let me know.

That said, I've left out a section on asset preprocessing which *should*
eventually go here. That is substantially more uncertain, and requires
both more time to investigate and more expertise to review.

---------

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Co-authored-by: TrialDragon <31419708+TrialDragon@users.noreply.github.com>
Co-authored-by: NotAFile <notafile@gmail.com>
Co-authored-by: Zachary Harrold <zac@harrold.com.au>
Co-authored-by: JMS55 <47158642+JMS55@users.noreply.github.com>
Co-authored-by: Jan Hohenheim <jan@hohenheim.ch>
2024-09-17 22:07:37 +00:00
..
io Add module and supporting documentation to bevy_assets (#15056) 2024-09-17 22:07:37 +00:00
processor Depreciate LoadAndSave Asset Processor (#15090) 2024-09-09 16:01:14 +00:00
server Add module and supporting documentation to bevy_assets (#15056) 2024-09-17 22:07:37 +00:00
assets.rs Fix rust beta lints (#14537) 2024-07-31 01:27:26 +00:00
direct_access_ext.rs Add methods to directly load assets from World (#12023) 2024-02-27 00:28:26 +00:00
event.rs Added AssetLoadFailedEvent, UntypedAssetLoadFailedEvent (#11369) 2024-01-17 21:12:00 +00:00
folder.rs Bevy Asset V2 (#8624) 2023-09-07 02:07:27 +00:00
handle.rs reflect: implement the unique reflect rfc (#7207) 2024-08-12 17:01:41 +00:00
id.rs Allow phase items not associated with meshes to be binned. (#14029) 2024-06-27 16:13:03 +00:00
lib.rs Add module and supporting documentation to bevy_assets (#15056) 2024-09-17 22:07:37 +00:00
loader_builders.rs Fix intra-doc links and make CI test them (#14076) 2024-07-11 13:08:31 +00:00
loader.rs Add module and supporting documentation to bevy_assets (#15056) 2024-09-17 22:07:37 +00:00
meta.rs Optimize common usages of AssetReader (#14082) 2024-07-01 19:59:42 +00:00
path.rs Replace bevy_utils::CowArc with atomicow (#14977) 2024-08-30 00:43:07 +00:00
reflect.rs reflect: implement the unique reflect rfc (#7207) 2024-08-12 17:01:41 +00:00
saver.rs Add module and supporting documentation to bevy_assets (#15056) 2024-09-17 22:07:37 +00:00
transformer.rs Depreciate LoadAndSave Asset Processor (#15090) 2024-09-09 16:01:14 +00:00