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

Documentation does not explain underlying structural model, makes program more difficult to understand #13

Open
DocSunset opened this issue Nov 28, 2018 · 2 comments
Assignees

Comments

@DocSunset
Copy link

DocSunset commented Nov 28, 2018

The hierarchy / relationship between states, syncs, events, conditions, triggers, intervals, processes, etc. is not explained anywhere in the documentation. Having just been given an explanation from Pia, I find that knowing the underlying model makes many aspects of the program much easier to understand, whereas before I found it quite opaque how these objects relate to each other, which owns what, or even the purpose of certain UI elements such as the "put in new event" and "desynchronize" buttons in the inspector for a state.

It would be great to have an explanation of these concepts somewhere in the documentation (e.g. as a new "In Depth" page), as it makes certain things much more obvious.

@bltzr
Copy link
Member

bltzr commented Nov 29, 2018

thanks @DocSunset you're absolutely right this should be explained somewhere in the doc (and where you point at seems a natural place)
I guess that's a mission for @jln- then - feel like, Julien ?

@jcelerier jcelerier transferred this issue from ossia/score Apr 28, 2021
@thibaudk
Copy link
Member

I actually wanted to make an introductory one in the quick start.
A section called "Working with time".

here is the pr #7

@bltzr bltzr self-assigned this Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants