54fa016af1
* Use compile mermaid extension * initial Mermaid arch diagram * updating mmd extension * small mmd update * Adding git add step * Expanding acronym * adding branch spec * Add changes * outputting SVG instead as PNG is too small * Add changes * updating readme * Backlog->Roadmap * Add changes * Updating casing for consistency * Updating documentation to specify 'update' section applies just to diagram Co-authored-by: GitHub Action <action@github.com> |
||
|---|---|---|
| .. | ||
| architecture-mmd.svg | ||
| architecture.mmd | ||
| README.md | ||
Architecture
The below is a general architecture of our proposed system:
Updating the Diagram
Note: Do Not directly modify the svg file, it is generated automatically!
In the event that you are interested in updating the architecture of our system, please go through the Architecture Decision Record Process (see here for more detail on this process).
Provided you have already done this, however, and/or would like to make small changes to the diagram itself, please read on!
This diagram was generated from a text-based markdown-like file using MermaidJS syntax and the Compile Mermaid Markdown Github Action.
To update, consult Mermaid syntax here and update the architecture.mmd file.
To preview your changes, see Use Cases and Integrations here in order to setup editor integration.
Once you are satisfied with your change, create a pull request. The compile_mermaid.yml workflow (here) will automatically generate and commit an SVG version of your diagram with the name X.svg.