search

jkboyce / jugglinglab

Juggling Lab juggling animator
https://jugglinglab.org
GNU General Public License v2.0
86 stars 17 forks source link

No documentation about ladder editor #104

Open hapiel opened 2 years ago

hapiel commented 2 years ago

The editor page says "just figure it out" on the ladder editor.

Which is fine for most parts (really cool feature!), but the phrasing of the menu items "define throw" and "change to catch" made me wrongly assume that I could change events into catches and throws.

I'll gladly write a bit of documentation later, and check in with you if I understood everything correctly.

jkboyce commented 2 years ago

Better documentation has been on my to-do list for eons. Now that the Visual Editor features are "done" (of course they're never actually done) it seems like a good time to document things.

What do you think would be the most useful format? I've had people suggest a video walkthrough as being perhaps more useful than written documentation.

hapiel commented 2 years ago

I enjoy videos, I already had made a mental note to offer to make a video rundown of all of juggling labs features. This definitely seems like something that would be easy to capture in videos indeed. (see the kind of videos I sometimes make here: https://youtu.be/mSpcOidA3iI )

Alternatively, a document with short animated instruction gifs is also not hard to make, fits into the current documentation format, and allows for text in between which is searchable and google indexable. There are arguments for both (and one does not exclude the other), and in both cases I might be able to help.