after-effects-scripting-guide icon indicating copy to clipboard operation
after-effects-scripting-guide copied to clipboard

Add more practical examples

Open zlovatt opened this issue 2 years ago • 0 comments

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 avatar Sep 19 '23 22:09 zlovatt