feat: add high-level architecture document #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scotwells
requested review from
JoseSzycho,
OscarLlamas6,
cc-datum,
drewr,
ecv and
zachsmith1
scotwells
force-pushed
the
feat/high-level-architecture-docs
branch
2 times, most recently
from
8289b2d to
04ea7d7
Compare
scotwells
force-pushed
the
feat/high-level-architecture-docs
branch
from
04ea7d7 to
8a387f9
Compare
This commit introduces a new architecture document that can be used to guide the high-level design of the system. This also includes C4 diagrams for the context and container level views of the system.
scotwells
force-pushed
the
feat/high-level-architecture-docs
branch
from
8a387f9 to
5bf258c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This introduces a new architecture document that can be used to guide the high-level design of the system. This also includes C4 diagrams for the context and container level views of the system.
Important
If you are not familiar with the C4 model, I recommend watching this video on visualizing software architecture with C4 to quickly get up to speed on the concept.
I've found C4 to be very useful for visualizing software systems.
I chose to use PlantUML's C4 plugin for rendering the C4 diagrams because it's the most mature option out there. Mermaid supports C4, but it's awful. I considered Structurizr, but it doesn't seem worth it.
I included taskfile commands for generating the C4 diagrams from the plantuml code. I also included a GitHub action workflow for verifying the
task generatecommand does not produce a diff to prevent PRs from being merged until code has been re-generated.@JoseSzycho I'll explicitly wait for your approval on this before merging since you'll be taking lead on implementation.
Closes #3