docs: add documentation about the structure/architecture of the code #250
Conversation
This file contains 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
meretp
requested changes
Mar 17, 2025
There was a problem hiding this comment.
I think this is a good high-level overview on the architecture and in general I like the diagram, I just have a few comments what could be improved. One more general comment, looking at the architecture/file structure I feel like you are following a certain pattern, I don't know exactly how this pattern is called, but maybe you can add a more general sentence on this as well?
abraemer
force-pushed
the
docs-architecture
branch
from
19e57a7 to
95f513a
Compare
Closed
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.
Document the structure of the code with a diagram and some text.