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

Revert accidentally added asset docs #15054

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

alice-i-cecile
Copy link
Member

Our branch protection rules were misconfigured, allowing me to push directly to origin/main 😱 This is now resolved:

image

This PR reverts those accidental changes, which will get their own PR momentarily...

This reverts commit ba1f13f.

Revert "Add note on `AssetServer::load` not being wasteful"

This reverts commit 480c2bc.

Revert "Basic practical overview"

This reverts commit a4b51d7.

Revert "Clarify relationships between saving, loading, reading and writing"

This reverts commit 22aa9ab.

Revert "Add advice on handles and reference counting"

This reverts commit f016aea.

Revert "Basic docs for `Asset` and `VisitAssetDependencies`"

This reverts commit 77c5efc.

Revert "Initial overview"

This reverts commit 1a9e55f.
@alice-i-cecile alice-i-cecile added P-High This is particularly urgent, and deserves immediate attention A-Meta About the project itself D-Trivial Nice and easy! A great choice to get started with Bevy S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Sep 5, 2024
@alice-i-cecile alice-i-cecile added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Sep 5, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Sep 5, 2024
Merged via the queue into bevyengine:main with commit 5589f0d Sep 5, 2024
32 checks passed
alice-i-cecile added a commit to alice-i-cecile/bevy that referenced this pull request Sep 5, 2024
github-merge-queue bot pushed a commit that referenced this pull request Sep 17, 2024
# 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Meta About the project itself D-Trivial Nice and easy! A great choice to get started with Bevy P-High This is particularly urgent, and deserves immediate attention S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants