-
-
Notifications
You must be signed in to change notification settings - Fork 89
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] Tooltip guidelines #1356
base: master
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
@atomiks Perhaps "Accessibility" or "Accessibility Guidelines" is a better heading? Also, this should come after the API Reference. The first thing you see for any component should be the demo and the anatomy. |
Hmm yeah, "Accessibility guidelines" is likely better. Other guidelines like "Design guidelines" can be separate from accessibility guidelines, if we decide to add them at some point.
I somewhat disagree here (even though I think it looks cleaner). The user may not reach the end of the API reference before deciding to start using the component since they didn't see the guidelines - it's important that they understand they're using the right component up front/as soon as possible before diving in. |
Before the API reference, it's a good idea to list guidelines to ensure users are using the right component. This is currently a plain section/paragraph, but we can add callouts or styling/colors.
Part of #559
Preview