-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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 <[email protected]> Co-authored-by: TrialDragon <[email protected]> Co-authored-by: NotAFile <[email protected]> Co-authored-by: Zachary Harrold <[email protected]> Co-authored-by: JMS55 <[email protected]> Co-authored-by: Jan Hohenheim <[email protected]>
- Loading branch information
1 parent
612731e
commit 23aca13
Showing
5 changed files
with
170 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters