Added mermaid-js to Diagramming Tools #66
Conversation
This file contains 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.
In one of the companies, I worked for we did a lot of integration with external services. It involved calling multiple APIs in different layers, i.e. mobile app calls our API, our API calls external service, etc.
Mermaid allows creating a sequence diagram which worked best for documenting this kind of integration flows. It has its editor and declarative syntax, therefore we used to create these sequence diagrams and store the source file in mermaid syntax in the repository. For me it was a pretty nice solution, that's why I created this pull request.