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

Clarify doc around systems #104

Merged
merged 4 commits into from
Oct 28, 2023
Merged

Clarify doc around systems #104

merged 4 commits into from
Oct 28, 2023

Conversation

djeedai
Copy link
Owner

@djeedai djeedai commented Oct 27, 2023

Clarify the documentation around animation systems, which ones are added automatically by the TweeningPlugin and which ones need to be added manually, depending on which feature is active.

  • Expand the Setup section of the README to explain the systems need to be added manually for most components and assets, and give a table for built-in ones where the system is automatically added.
  • Add a similar section to the rustdoc section of lib.rs.

Also fix a couple of doc links.

Bug: #103

Clarify the documentation around animation systems, which ones are added
automatically by the `TweeningPlugin` and which ones need to be added
manually, depending on which feature is active.
- Expand the Setup section of the README to explain the systems need to
  be added manually for most components and assets, and give a table for
  built-in ones where the system is automatically added.
- Add a similar section to the rustdoc section of `lib.rs`.

Also fix a couple of doc links.

Bug: #103
@djeedai djeedai added the documentation Improvements or additions to documentation label Oct 27, 2023
@djeedai
Copy link
Owner Author

djeedai commented Oct 27, 2023

@SecretPocketCat if you want to have a look at this change and let me know if the wording around animation systems sounds more clear that way? Thanks

@SecretPocketCat
Copy link
Contributor

That's much better, thank you.

I added a few nits in #105 (just missing spaces) and replaced the mention of built-in Bevy components in case someone is just skimming the docs, but that's upto you.

@djeedai djeedai merged commit bc12d36 into main Oct 28, 2023
8 checks passed
@djeedai djeedai deleted the u/doc-sys branch October 28, 2023 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants