Use mermaid for "defmt ecosystem" diagram #764
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.
What
This PR removes the previous (static) diagram of the defmt ecosystem from the README and replaces it with a mermaid code block.
Context
Mermaid is a JavaScript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. It is widely used. By now both GitHub and crates.io do render mermaid diagrams, in GitHub you can even interact with them (zooming in and out mostly, but still).
Why
This change will make it easier to keep the diagram up to date, since we don't rely on other tooling (draw.io in our case) to modify the diagram.
Drawbacks
As a grain of salt I have to say that I actually do like the aesthetics of the previous diagram more (see below). But I still think that the advantages outweigh that. It is possible to style the mermaid diagram with CSS, but I did not want to go down that road.
Before
After