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

Update docs to discourage standalone tooltip use. #1306

Merged
merged 3 commits into from
Aug 15, 2022
Merged

Conversation

khiga8
Copy link
Contributor

@khiga8 khiga8 commented Aug 15, 2022

Fixes: #1299

Since some Primer components now support tooltip and we want to emphasize not using tooltip directly, the examples in the tooltip docs should use Button, IconButton, or Link. This PR swaps the examples and makes some edits to the tooltip docs.

@khiga8 khiga8 requested review from a team and camertron August 15, 2022 14:34
@changeset-bot
Copy link

changeset-bot bot commented Aug 15, 2022

🦋 Changeset detected

Latest commit: d940f70

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/view-components Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@khiga8 khiga8 temporarily deployed to github-pages August 15, 2022 14:38 Inactive
@khiga8 khiga8 temporarily deployed to github-pages August 15, 2022 14:44 Inactive
Copy link
Member

@jonrohan jonrohan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed we're missing the Tooltip link in the sidebar nav of the docs site. Not sure if that was intentional. Should we add it?

Either way, not related to your update so 👍🏻

@khiga8 khiga8 temporarily deployed to github-pages August 15, 2022 15:43 Inactive
@khiga8 khiga8 merged commit 5e9003e into main Aug 15, 2022
@khiga8 khiga8 deleted the kh-update-docs branch August 15, 2022 15:54
@primer-css primer-css mentioned this pull request Aug 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The Primer::Alpha::Tooltip examples should be using the component API
2 participants