Documentation ?

[arthurwolf]

Is there any documentation of methods and events? I don't see much in the readme outside of just getting it to run. Now that I have that figured out, I need to figure out how to read methods, dynamically add rows/keyframes etc. What's the best source of information for this?

Thanks a lot.

[ievgennaida]

Hello Arthur, The Readme is the only documentation presented at the moment. Also TypeScript will show you functions and arguments intellisense.

Another option is to check the code directly in the demo file: https://github.com/ievgennaida/animation-timeline-control/blob/master/index.html

Please list all the features you have struggled or need additional information or feel free to create merge request with the missing information.

BR, Ievgen

[arthurwolf]

Thanks a lot for your reply.

I've ended up just reading most of the source code for the actual library last night, so I think i've found most of what I need. Not the best user experience though...

Have you considered just feeding the source code into a GPT4/Claude prompt and asking it to generate docs for you?

I created a prompt that includes the demo code, the readme, and several of the source code files (I included only a couple but claude has enough context that you can include pretty much all the project's typescript) , then asked both gpt4-turbo and claude3-opus (currently free) to generate docs. The results I got, I expect, would save a lot of time when writing docs yourself:

https://gist.github.com/arthurwolf/ed156cef25e50a7014117a189a97fd0e

Note in this prompt I asked it to write all the docs all at once. That's probably not the right approach. If instead I had ask ed it to write docs (including usage example, all details on parameters and returns, etc) on one singular function, it would probably have done a better job. Then I would just need to do the same for each method/function/event.

Cheers.

[ievgennaida]

I am glad that you have found a way of using a tool. BR