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

Add docs.rs documentation #1

Merged
merged 11 commits into from
Dec 20, 2023
Merged

Add docs.rs documentation #1

merged 11 commits into from
Dec 20, 2023

Conversation

mbrea-c
Copy link
Owner

@mbrea-c mbrea-c commented Dec 7, 2023

Currently the docs.rs page is pretty barren. before leaving alpha this needs to be populated with enough information for users to get started.

TODO:

  • Minimal examples
    • How to use graph animation player, and how to replace bevy's own animation players is specific entities.
    • Graphs as assets
    • Programmatically creating graphs with API (Won't do in this PR)
    • Graph with custom node (Won't do in this PR)
  • Explanation of how the animation graph works.
  • Documentation of available nodes with inputs and outputs specified. This should be linked from front page. (Inputs and outputs will be documented in future patch).

@mbrea-c mbrea-c marked this pull request as draft December 7, 2023 14:51
@mbrea-c mbrea-c added the documentation Improvements or additions to documentation label Dec 7, 2023
@mbrea-c mbrea-c marked this pull request as ready for review December 20, 2023 12:59
@mbrea-c mbrea-c merged commit cc77f27 into master Dec 20, 2023
4 checks passed
@mbrea-c mbrea-c deleted the add_more_docs branch June 10, 2024 17:38
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.

None yet

1 participant