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

docs: add design diagram #183

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add design diagram #183

wants to merge 2 commits into from

Conversation

suchapalaver
Copy link
Contributor

This is a rendering in PUML of a design diagram drawn up by @gusinacio that Semiotic teammates can see here.

The PUML can generate SVC format diagrams that can be viewed nicely in GitHub.

The idea is that we can collaborate further on this.

Signed-off-by: Joseph Livesey [email protected]

@coveralls
Copy link

coveralls commented May 22, 2024

Pull Request Test Coverage Report for Build 9184510884

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 68.814%

Totals Coverage Status
Change from base Build 9178939273: 0.0%
Covered Lines: 3760
Relevant Lines: 5464

💛 - Coveralls

Copy link
Collaborator

@aasseman aasseman left a comment

Choose a reason for hiding this comment

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

LGTM, could you generate a larger / nicer looking SVG though? Also perhaps you can add the command you used to generate the SVG, maybe as a comment in the puml file?

@suchapalaver suchapalaver force-pushed the joseph/design-diagram branch 2 times, most recently from 5ec51b1 to b90dfc7 Compare May 22, 2024 02:12
@suchapalaver
Copy link
Contributor Author

LGTM, could you generate a larger / nicer looking SVG though? Also perhaps you can add the command you used to generate the SVG, maybe as a comment in the puml file?

I believe the preview of the file on GitHub renders the SVG at a fixed size. I've embedded the SVG file in the README now to see if that looks satisfactory.

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

Successfully merging this pull request may close these issues.

None yet

3 participants