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

[Draft] Docs setup #5

Merged
merged 40 commits into from
Jan 24, 2024
Merged

[Draft] Docs setup #5

merged 40 commits into from
Jan 24, 2024

Conversation

mbasaglia
Copy link
Member

Setting up a build system for documentation with schema integration.

Output: https://lottiefiles.github.io/lottie-spec/specs/composition/

@cla-bot cla-bot bot added the cla-signed label Dec 14, 2023
@mbasaglia
Copy link
Member Author

For now it uses the default style of one of the mkdocs themes, that will need to be updated before merging

@mbasaglia
Copy link
Member Author

As part of this I'm expanding some descriptions on the schema and renaming some objects to increase clarity.

@mbasaglia
Copy link
Member Author

mbasaglia commented Dec 15, 2023

This is an example of what a generated page would look like. The description and property table are pulled from the schema, and an interactive example shows what the properties do.

Screenshot_20231215_211959

@mbasaglia mbasaglia marked this pull request as ready for review December 21, 2023 18:55
Copy link
Member

@fmalita fmalita left a comment

Choose a reason for hiding this comment

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

Thanks Mattia, this looks great!

docs/editing/schema.md Outdated Show resolved Hide resolved
docs/specs/properties.md Outdated Show resolved Hide resolved
docs/specs/properties.md Show resolved Hide resolved
docs/specs/properties.md Show resolved Hide resolved
docs/specs/properties.md Outdated Show resolved Hide resolved
docs/specs/properties.md Outdated Show resolved Hide resolved
Copy link
Member

@Aidosmf Aidosmf left a comment

Choose a reason for hiding this comment

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

thanks

Copy link
Contributor

@jbeta51 jbeta51 left a comment

Choose a reason for hiding this comment

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

LGTM, harder to review since this is a large migration, but checking the site everything looks good.

@mbasaglia mbasaglia merged commit a3691a7 into lottie:main Jan 24, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants