C4 Model using Mermaid

[werberger]

@brylie I have created some draft diagrams in Mermaid. Namely a Context, Container and two Component diagrams.

I have a number of questions but my main one is whether they're even along the lines of what you are thinking?
Either way would appreciate your thoughts before I create a PR.

Worth nothing that I'm not sure I'm sufficiently across the project (conceptually or technically) to build very meaningful diagrams. So the more specific/detailed you can be, the more likely I'll accurately make the changes you'd like.

And just checking, I should create an issue before making a PR anyway, right?

Component Diagram

Component Diagram (Web Application)

Component Diagram (REST API)

[brylie]

This looks great! Let's try embedding the Mermaid source code directly in a Markdown file in our project documentation. E.g., create a new architecture.md file and use the GitHub mermaid codefence to render the diagrams.

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams

[werberger]

So glad. Plus I already did these diagrams using Mermaid in an architecture.md file :)

Can create a pull request but do you want me to create an issue first?

[brylie]

Great 🙂

Yes, ideally around 95% of pull requests would be linked to an issue, so go ahead and open the issue and then a linked PR. It's just to practice a good habit.