Skip to content

Documented the components of the architecture diagram #145

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
Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Documented the components of the architecture diagram #145

wants to merge 3 commits into from
+51 −1

Conversation

Karan-Palan
Copy link

Fixes #144

image

Please review @walterbender , @meganindya . Is this a good start ?

@walterbender
Copy link
Member

This is a solid start. We can make further edits as necessary. Thx.

@walterbender
Copy link
Member

Some lint errors:

/github/workspace/docs/images/README.md:7:101 MD013/line-length Line length [Expected: 100; Actual: 587]
/github/workspace/docs/images/README.md:11:101 MD013/line-length Line length [Expected: 100; Actual: 593]
/github/workspace/docs/images/README.md:15:101 MD013/line-length Line length [Expected: 100; Actual: 431]
/github/workspace/docs/images/README.md:19:101 MD013/line-length Line length [Expected: 100; Actual: 438]
/github/workspace/docs/images/README.md:23:101 MD013/line-length Line length [Expected: 100; Actual: 591]
/github/workspace/docs/images/README.md:27:101 MD013/line-length Line length [Expected: 100; Actual: 508]
/github/workspace/docs/images/README.md:31:101 MD013/line-length Line length [Expected: 100; Actual: 545]
/github/workspace/docs/images/README.md:33 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
/github/workspace/docs/images/README.md:34 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Scheduler"]
/github/workspace/docs/images/README.md:35:101 MD013/line-length Line length [Expected: 100; Actual: 476]
/github/workspace/docs/images/README.md:39:101 MD013/line-length Line length [Expected: 100; Actual: 449]
/github/workspace/docs/images/README.md:43:101 MD013/line-length Line length [Expected: 100; Actual: 293]
/github/workspace/docs/images/README.md:45 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Monitor"]
/github/workspace/docs/images/README.md:46:101 MD013/line-length Line length [Expected: 100; Actual: 185]
/github/workspace/docs/images/README.md:48 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
/github/workspace/docs/images/README.md:49:101 MD013/line-length Line length [Expected: 100; Actual: 438]
/github/workspace/docs/images/README.md:49:438 MD047/single-trailing-newline Files should end with a single newline character

@Karan-Palan
Copy link
Author

Some lint errors:

Sorry, this might add a fix to those

apoorvapendse
apoorvapendse reviewed Apr 13, 2025
View reviewed changes
docs/images/README.md
## Library Elements

The Library Elements component provides a set of predefined element classes that can be used in the system. These element classes can be extended or customized as needed. The Library Elements component provides a set of pre-built element classes that can be used to create new element instances in the system. These element classes define the structure and behavior of the elements, as well as any default values or settings. The arrows in and out of the Library Elements box represent the flow of data and element classes between the Library Elements and the other components in the system.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first and third sentence seem to mean the same.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apoorvapendse apoorvapendse apoorvapendse left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document components of the architecture diagram.
3 participants
@Karan-Palan @walterbender @apoorvapendse