-
Notifications
You must be signed in to change notification settings - Fork 3
Updated getting-started.mdx #11
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
base: main
Are you sure you want to change the base?
Conversation
Edited a part of the Getting Started page for easy comprehension
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, great job. Only a few things to fix.
Please, next time run the docs locally before submitting a PR, it would solve many problems right away.
| You can access the timeline by pressing <span className="pixi-icon icon-timeline"/> button on top of the screen. | ||
| ### Timeline interface overview | ||
| The following image shows the interface of the timeline. | ||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
./img/annotated-timeline.png doesn't exist. You probably meant ./assets/annotated-timeline.png
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for the feedback. I will work on them and run the docs locally first, next time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also want to confirm, do you have a style guide for documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, there's no style docs unfortunately
|
|
||
| PixiEditor offers two main ways to animate your projects: **Frame by Frame** and **Procedurally**. | ||
| Both methods can be used together freely. | ||
| # Getting started with animations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the blue is slightly better but the highlights are really uneven (arrow on pt. 3, boxes on pt 5 and 3)
It's a nitpick but points 7 and 6 covering only part of the UI is slightly weird, at least pt. 7 should include the last cel in the animation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you explain the "arrow on pt.3, boxes on pt 5 and 3". I do not really understand that. Also, I think having point 6 cover the whole UI will make the image more demanding on the eyes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean that arrow on pt.3 is not a straight line and boxes on pt.5 and 3 are covering part of UI (icons are cut off by the blue line).
I think having point 6 cover the whole UI will make the image more demanding on the eyes.
Maybe yeah, although I'd still cover the last cel with other cels, so it doesn't feel lonely ;)
| - Image Preview - It displays the layer's **base** image. | ||
| - Layer Name | ||
| - <span className="pixi-icon icon-chevron-down"/> Collapse button, it squishes whole layer animation row, so it takes minimal space. | ||
| - <span className="pixi-icon eye-icon"/> **Eye icon** - Show/hide the layer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not a valid icon. It should be icon-eye
| ## Procedural Animations | ||
| ### 2. Procedural animations | ||
| This method uses operations and parameters to create movement without manually drawing frames. Think of it as giving a set of instructions. For example: *Move to the right by 10 pixels over 1 second.* | ||
| With this method, you can animate almost any property within the Node graph. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd capitalize g in Node graph
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay. Just to confirm, is it "Procedural animations" or "Procedural Animations"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say both are fine as long as they are used consistently

Made changes to getting-started.mdx in these areas: