Added technical sequence diagram to example docs #2836
Merged
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.
📑 Summary
As explained in the issue, I believe some examples orientated more to software might be good to give a better understanding of how to use the diagrams in real-world scenarios.
I will be contributing some more as I get time.
Resolves #2795
📏 Design Decisions
In issue #2795, I stated additions to the sequence diagrams page on the docs, I opted to instead simply add to the examples page as this makes more sense for more advanced use-cases while keeping the diagram specific docs orientated towards documenting the features of that diagram type.
📋 Tasks
Make sure you
develop
branch