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

include typography utility class names in example text content #2633

Merged
merged 1 commit into from
Jun 3, 2024

Conversation

ktravers
Copy link
Contributor

@ktravers ktravers commented Jun 1, 2024

Related

primer/design#796

What are you trying to accomplish?

Whenever I look up typography utility classes, I end up having to inspect the markup in the embedded Storybook to get the actual class name. It would be much easier if the class names were written out in the text content instead, so they could be copy/pasted directly from the page, without having to take the extra step of inspecting the page source.

This PR adds the class names to the storybook text content.

What approach did you choose and why?

I updated the storybook text content.

What should reviewers focus on?

My intention is to make this documentation easier to use. I'd appreciate feedback on whether these changes do in fact seem like an improvement. Also very open to suggestions if folks have them.

Can these changes ship as is?

  • Yes, this PR does not depend on additional changes. 🚢

Related

primer/design#796

## Context

Whenever I look up typography utility classes, I end up having to inspect the markup in the embedded Storybook to get the actual class name. It would be much easier if the class names were written out in the text content instead, so they could be copy/pasted directly from the page, without having to take the extra step of inspecting the page source.

## Summary

This PR adds the class names to the storybook text content.

## Related

primer/design#796
@ktravers ktravers self-assigned this Jun 1, 2024
@ktravers ktravers requested a review from a team as a code owner June 1, 2024 19:14
Copy link

changeset-bot bot commented Jun 1, 2024

⚠️ No Changeset found

Latest commit: b62e15b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

@langermank langermank left a comment

Choose a reason for hiding this comment

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

This is awesome, thanks so much! 🙌

@langermank langermank merged commit baf0cdc into main Jun 3, 2024
14 checks passed
@langermank langermank deleted the ktravers/typography-utilities branch June 3, 2024 18:22
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.

2 participants