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] Tooltip guidelines #1356

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

atomiks
Copy link
Contributor

@atomiks atomiks commented Jan 27, 2025

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

@atomiks atomiks added the docs Improvements or additions to the documentation label Jan 27, 2025
Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for base-ui ready!

Name Link
🔨 Latest commit 1f8c54e
🔍 Latest deploy log https://app.netlify.com/sites/base-ui/deploys/67a0a439792ef7000871904f
😎 Deploy Preview https://deploy-preview-1356--base-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@atomiks atomiks marked this pull request as ready for review January 28, 2025 06:39
@colmtuite
Copy link
Contributor

colmtuite commented Feb 3, 2025

@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.

@atomiks
Copy link
Contributor Author

atomiks commented Feb 3, 2025

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.

Also, this should come after the API Reference.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants