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

Added technical sequence diagram to example docs #2836

Merged
merged 2 commits into from
Mar 24, 2022
Merged

Added technical sequence diagram to example docs #2836

merged 2 commits into from
Mar 24, 2022

Conversation

riaanduplessis
Copy link
Contributor

📑 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

  • 📖 have read the contribution guidelines
  • 💻 have added unit/e2e tests (if appropriate)
  • 🔖 targeted develop branch

Copy link
Collaborator

@ashishjain0512 ashishjain0512 left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution.

@ashishjain0512 ashishjain0512 merged commit c3e9382 into mermaid-js:develop Mar 24, 2022
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.

Doc improvements for sequence diagram examples
2 participants