docs: add technical flow mermaid diagrams #621
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.
Motivation
I faced some issues when I used Spegel because of wrong assumptions that I've made on how the project works, which motivated me to dive into the code to understand better. So, I created these diagrams to help me understand and to help others who get to same situations I was in.
Diagrams
Caveat
(These diagrams are based on my current understanding of the inner workings of the project), I created the diagrams as mermaid diagrams to they can be corrected or updated in the future as the project evolves.