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

Use design system link styles in documentation #252

Merged
merged 2 commits into from
Sep 22, 2021
Merged

Conversation

aduth
Copy link
Member

@aduth aduth commented Sep 22, 2021

Related: GSA-TTS/identity-handbook#163

Why: Because a design system's documentation should ideally leverage said design system's own link styles.

Live preview: https://federalist-2f194a10-945e-4413-be01-46ca6dae5358.app.cloud.gov/preview/18f/identity-style-guide/aduth-docs-links/

Before After
image image

**Why**: Because a design system's documentation should ideally leverage said design system's own link styles.
Copy link
Contributor

@jmdembe jmdembe left a comment

Choose a reason for hiding this comment

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

👍🏾

Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -12,7 +12,7 @@ The color codes listed beneath each name indicate what names can be used with th
This element has classes <code>bg-primary-lighter</code> and <code>text-primary-dark</code>.
</div>

Read more about <a href="https://v2.designsystem.digital.gov/utilities/color/" target="_blank">the U.S. Web Design System’s color utility classes</a>.
Read more about [the U.S. Web Design System’s color utility classes](https://designsystem.digital.gov/utilities/color/).
Copy link
Contributor

Choose a reason for hiding this comment

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

removing target="_blank" is intentional right? the kramdown doesn't add it back in

Copy link
Member Author

@aduth aduth Sep 22, 2021

Choose a reason for hiding this comment

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

removing target="_blank" is intentional right? the kramdown doesn't add it back in

Good spot and yes, target="_blank" will be removed with these changes. I don't think this page qualifies for any of the standard exceptions of opening a new tab only when necessary, so I didn't care much to retain it.

This also applies to links on the homepage as well.

@aduth
Copy link
Member Author

aduth commented Sep 22, 2021

The current visual regression test failure reflects the link changes, and is expected.

@aduth aduth merged commit 54c752b into main Sep 22, 2021
@aduth aduth deleted the aduth-docs-links branch September 22, 2021 17:38
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.

3 participants