Skip to content

Conversation

@MwithHeart
Copy link

@MwithHeart MwithHeart commented Sep 23, 2025

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

  • Grouped related information to make onboarding easier.
  • Reorganized sections
  • Changed the "timeline UI" image to one with better annotations. And added the image "annotated-timeline.png" to assets.

Copy link
Member

@flabbet flabbet left a 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.
![The timeline interface](./img/annotated-timeline.png "The timeline interface")
Copy link
Member

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

Copy link
Author

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.

Copy link
Author

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?

Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary duplication

Image

Copy link
Member

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.

Copy link
Author

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.

Copy link
Member

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
Copy link
Member

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.
Copy link
Member

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

Copy link
Author

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"

Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants