add mermaid js diagram and update README - #7
Open
arijitroy003 wants to merge 4 commits into
Open
Conversation
Member
Author
|
I added this section in README, which points to each code, making easier to contribute and go through how it works. |
Contributor
|
Thanks @arijitroy003 for raising this MR of the diagram. I think we do need to add more details to the diagram. Specifically, the invoke analyzer piece. Currently, we only have one rule (Webhook rule), so this diagram does make sense, but it would require more changes to be integrated. I am surely planning to add a documentation around how to add new rules to rule manager. Maybe having some more rules will make it easier for creating appropriate diagrams. |
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
2 participants
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.
Update Readme to add Code walkthrough diagram