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.

Sign up for GitHub

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

Jump to bottom

Document components of the architecture diagram. #144

Open
11 tasks
walterbender opened this issue Feb 26, 2024 · 1 comment · May be fixed by #145
Open
11 tasks

Document components of the architecture diagram. #144

walterbender opened this issue Feb 26, 2024 · 1 comment · May be fixed by #145
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@walterbender
Copy link
Member

walterbender commented Feb 26, 2024 •
edited
Loading

Architecture

We have a block diagram of the project architecture; but we need a README.md file (in the docs subdirectory) that includes descriptions of each component of the diagram.

  • Element API
  • Specification
  • Warehouse
  • Tree
  • Library Elements
  • Plugin Elements
  • Symbol Table
  • Scheduler
  • Parser
  • Interpreter
  • Monitor

The documentation should describe the functionality of each component and the role of the arrows in and out of each box.
@walterbender walterbender added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 26, 2024
@Karan-Palan
Copy link

@walterbender , the architecture image is not visible

@Karan-Palan Karan-Palan linked a pull request Feb 27, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documented the components of the architecture diagram Karan-Palan/musicblocks-v4-lib
2 participants
@walterbender @Karan-Palan