search

mermaid-js / mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
https://mermaid.js.org
MIT License
68.77k stars 6.08k forks source link

DOCS: C4, XY and Block diagrams have special icons with unclear meaning #5346

Open viblo-majority opened 4 months ago

viblo-majority commented 4 months ago

There are 3 diagrams with special icons next to their names in the documentation. As a user it's not clear what they mean, and I can't see any way to find out.

Maybe it could be fixed with a hover text, or if the reasoning for icon is mentioned on the actual diagram page it could be included there. For example, on C4 there's a info box in the top that says its experimental. If this is the meaning of the two icons then those could be put in that box with the text.

image

nirname commented 2 weeks ago

Usually new diagrams that was recently added are marked with :fire: For the diagrams with experimental syntax that can change over time we use -beta suffix, so that users are aware of possible breaking changes.

Agree that icons by themselves can be meaningless. Contributions to documentation are welcome.