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

Draft architecture diagrams #14

Open
ghost opened this issue May 7, 2024 · 2 comments
Open

Draft architecture diagrams #14

ghost opened this issue May 7, 2024 · 2 comments
Assignees
Labels

Comments

@ghost
Copy link

ghost commented May 7, 2024

Having a few architecture diagrams, even as draft or sketch, in place would be quite useful to understand where we are and where we want to go. I found C4 Model have the right balance of flexibility and precision.

@ghost ghost changed the title Draft architecture diagram Draft architecture diagrams May 7, 2024
@rolas978
Copy link

What do you use to make the diagrams? UML-specific?
Would PlantUML be used in this case?
I found out about it recently, and some of the charts look great.
image

this is the guide:
https://plantuml.com/guide

@ghost
Copy link
Author

ghost commented May 13, 2024

PlantUML is nice, yes. And there's support for C4 style with

!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
!https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml

@KtorZ KtorZ assigned KtorZ and ghost May 16, 2024
@KtorZ KtorZ added the TASK label May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants