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.

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

docs(architecture): add architecture diagram #88

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Conversation

mandarvaze
Copy link
Contributor

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)

Copy link

codecov bot commented Oct 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 3.31%. Comparing base (c6e20e5) to head (5fbf01b).
Report is 2 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main     #88   +/-   ##
=====================================
  Coverage   3.31%   3.31%           
=====================================
  Files         19      19           
  Lines       2417    2417           
=====================================
  Hits          80      80           
  Misses      2337    2337           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@orhun orhun changed the title add: architecture.md docs(architecture): add architecture diagram Oct 26, 2024
@orhun orhun merged commit f580d6e into orhun:main Oct 26, 2024
26 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants