Inline architecture diagram in README#152
Merged
orangecoding merged 3 commits intoorangecoding:masterfrom Aug 2, 2025
Merged
Conversation
orangecoding
requested changes
Jul 26, 2025
|
|
||
| # Architecture | ||
|  | ||
|
|
Owner
Contributor
Author
orangecoding
approved these changes
Aug 1, 2025
Owner
orangecoding
left a comment
There was a problem hiding this comment.
There is 1 conflict. When resolved, we can merge it. Thanks!
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
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 MR aims to inline the architecture diagram in the Mermaid format natively supported for inline-rendering by Markdown.
Preview
https://github.com/alexanderroidl/fredy/blob/4d5d7bf5c11cc5c765003762723aa50e9c3ffd9f/README.md
flowchart TD subgraph Jobs["Jobs"] A1["Job 1"] A2["Job 2"] A3["Job 3"] end subgraph Providers["Providers"] C1["Provider 1"] C2["Provider 2"] C3["Provider 3"] end subgraph NotificationAdapters["Notification Adapters"] F1["Notification Adapter 1"] F2["Notification Adapter 2"] end A1 --> B["FredyRuntime"] A2 --> B A3 --> B B --> C1 & C2 & C3 C1 --> D["Similarity-Check"] C2 --> D C3 --> D D --> E{"Found<br>similarity?"} E -- No --> F1 F1 --> F2 style A1 fill:#fde9a0 style A2 fill:#fde9a0 style A3 fill:#fde9a0 style C1 fill:#c4c9f1 style C2 fill:#c4c9f1 style C3 fill:#c4c9f1 style F1 fill:#d2edba style F2 fill:#d2edba style B fill:#abd8f9 style D fill:#fab4a8 style E fill:#fffbb4