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.

Sign up for GitHub

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

Jump to bottom

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

Open
viblo-majority opened this issue Mar 1, 2024 · 2 comments · May be fixed by #5681
Open

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

viblo-majority opened this issue Mar 1, 2024 · 2 comments · May be fixed by #5681
Labels
Area: Documentation Contributor needed Status: Approved Is ready to be worked on

Comments

@viblo-majority
Copy link

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
@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Mar 1, 2024
@nirname
Copy link
Contributor

nirname commented Jun 19, 2024

Usually new diagrams that was recently added are marked with 🔥
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.

@nirname nirname added Contributor needed Status: Approved Is ready to be worked on Area: Documentation and removed Status: Triage Needs to be verified, categorized, etc labels Jun 19, 2024
@siddharthisrani
Copy link

siddharthisrani commented Jul 29, 2024 •
edited
Loading

Hiii @nirname ,

I’m eager to contribute and will update the documentation with explanations for the icons and info boxes. Would you prefer just the documentation update, or should I also include hover text for the icons? Please let me know. I’ll aim to have these changes done in 2 days.

P.S. Below is a sample of the documentation update I aim to implement:
mermaidnew

If you have any changes or additional suggestions, please let me know.

@siddharthisrani siddharthisrani linked a pull request Aug 1, 2024 that will close this issue
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: Documentation Contributor needed Status: Approved Is ready to be worked on
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: add icon explanations siddharthisrani/mermaid
3 participants
@nirname @viblo-majority @siddharthisrani