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 documentation for easier reference #796

Merged
merged 1 commit into from
Jun 10, 2024

Conversation

ktravers
Copy link
Contributor

@ktravers ktravers commented Jun 1, 2024

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 documentation 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 documentation. I tried to maintain consistency with how class names are already referenced elsewhere in the doc (ex. header class names).

Related

primer/css#2633

…ference

## 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 documentation 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 documentation. I'm opening a separate PR to add them within the storybooks as well.
@ktravers ktravers requested a review from a team as a code owner June 1, 2024 19:03
@ktravers ktravers self-assigned this Jun 1, 2024
ktravers added a commit to primer/css that referenced this pull request Jun 1, 2024
## 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
langermank pushed a commit to primer/css that referenced this pull request Jun 3, 2024
## 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
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.

Thank you! 😄

@langermank langermank merged commit 6492aea into main Jun 10, 2024
6 checks passed
@langermank langermank deleted the ktravers/typography-utilities branch June 10, 2024 22:11
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