docs(architecture): add architecture diagram #88
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
As discussed on discord, I've created Architecture document.
The markdown file contains the mermaid diagram code.
Benefit of this (over uploading an image) is that we do not need to keep updating the image.
Instead the mermaid diagram code itself can be updated (suing any editor) and changes will be reflected in the rendered image.
How has this been tested? (if applicable)
I verified that the image is correctly rendered using github's built-in editor (
preview
tab)