Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open
  • Is something wrong?
#13 2 comments 0 reactions 2 assignees View on GitHub

@bltzr is already working on this.

Since Jul 22, 2021.

Assessment

This issue has not been assessed yet.

Description

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.

Dominant language
Ruby
Stars
3
Forks
16
Avg merge
1d 6h
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ossia/score-docs

All issues in ossia/score-docs

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.