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

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

Open
viblo-majority opened this issue Mar 1, 2024 · 1 comment

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants