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

Improve animation documentation #1258

Closed
mwestphal opened this issue Feb 4, 2024 · 4 comments
Closed

Improve animation documentation #1258

mwestphal opened this issue Feb 4, 2024 · 4 comments
Assignees
Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation
Milestone

Comments

@mwestphal
Copy link
Contributor

Context
F3D doc has a short paragraph about animation: https://f3d.app/doc/user/USAGE.html#animations
While informative, it doesn't convey the full complexity of interacting with animation in F3D and animations in 3D formats in general.

Let's expand this doc in its own page

Suggested solution

  • Add a dedicated markdown file to cover how are animations defined in 3D models and how to interact with them in F3D
  • Move the short paragraph there as well
  • Add links wherever needed

Skills

  • Markdown
@mwestphal mwestphal added type:documentation Improvements or additions to documentation help wanted Please help with this issue! labels Feb 4, 2024
@mwestphal
Copy link
Contributor Author

discussed here initially: #1242

@mwestphal mwestphal added this to the 2.4.0 milestone Feb 4, 2024
@mwestphal
Copy link
Contributor Author

@kathleenhang wanna take this one ?

@kathleenhang
Copy link
Contributor

@kathleenhang wanna take this one ?

Hi Mathieu, sure thing! Let me know if there are any best practices I should know about for writing F3D documentation. Otherwise, I will go ahead and add my notes as I see best fit !

@mwestphal
Copy link
Contributor Author

For now animation is just a single paragraph.

I we want to expand this doc, we may be better adding a dedicated .md file for it, which means it should be listed in the index.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants