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

Message overview image is incomplete #212

Open
mpkorstanje opened this issue Mar 23, 2024 · 1 comment
Open

Message overview image is incomplete #212

mpkorstanje opened this issue Mar 23, 2024 · 1 comment

Comments

@mpkorstanje
Copy link
Contributor

🤔 What's the problem you've observed?

The image in the message overview in the readme is incomplete. This is bad because the structure is an important part of the message protocol and helps people find their way.

Additionally, by being a PNG it is hard to edit and will go out of date.

✨ Do you have a proposal for making it better?

Replace all images with mermaid diagrams or plant uml. I believe GitHub supports both.

📚 Any additional context?

The purpose of the diagrams is to show the relationships between different message. Not the details of the indivual messages. So ideally we coverall messages that go in the envelope and select parts of the Gherkin document.

@mpkorstanje
Copy link
Contributor Author

Also the Attachment message should be part of the test case execution section.

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

No branches or pull requests

1 participant