Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add architecture and data flow diagrams to README #45

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Add architecture and data flow diagrams to README #45

wants to merge 9 commits into from

Conversation

CBielstein
Copy link
Owner

Description

This PR adds architecture and data flow diagrams to the README. The effort is to simplify understanding a relatively complex system end-to-end.

In addition to the diagrams, I add text-based description to cover more developers preferences for how information is conveyed.

This uses mermaid diagrams, which may require an extension for your editor.

Changes

  • Add a mermaid diagram for the C4 system context diagram
  • Add a mermaid diagram for dataflow through the system

Validation

  • Looks just fine on my VS Code with a mermaid plugin
  • Will validate that GitHub can render it as well

@CBielstein CBielstein added the documentation Improvements or additions to documentation label Oct 10, 2023
@CBielstein CBielstein self-assigned this Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@CBielstein CBielstein

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@CBielstein