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 more practical examples #30

Open
zlovatt opened this issue Sep 19, 2023 · 0 comments
Open

Add more practical examples #30

zlovatt opened this issue Sep 19, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@zlovatt
Copy link
Member

zlovatt commented Sep 19, 2023

While some developers come into this doc knowing that it's mostly an API reference, it's a little obtuse for people trying to learn scripting.

To that end, adding more real-world examples into the docs would help make this appeal to a broader audience while still maintaining its status as the go-to API ref for AE scripting.

I could see this working in one of these ways (or any mix of):

  1. A new 'examples' top-level category, broken into sub-categories with examples in each
    • "Keyframes"
      • "Adding keyframes"
      • "Setting eases"
      • "Removing keyframes [note: need to do this in reverse!]", etc
    • "Render Queue"
      • "Rendering items"
      • "Setting render templates" [because this generally sucks]
  2. Adding an "Examples" page into each existing top-level category
    • "Property"
      • "Setting position values"
      • "Adding an expression"
  3. Specifically seeding the entire site with more inline examples under each property/method

Note that route 3 here may lead the docs to become a lot messier & harder to parse, for people looking for a clean API reference doc.

@zlovatt zlovatt added the enhancement New feature or request label Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant