Skip to content

Commit

Permalink
cleaning up docs pages for consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
emilybrick committed Jun 28, 2023
1 parent b152cea commit ba464ea
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
4 changes: 2 additions & 2 deletions content/components/avatar-pair.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ import {Box, Text} from '@primer/react'
import ComponentLayout from '~/src/layouts/component-layout'
export default ComponentLayout

## Usage

<img
width="960"
alt="An image showing two different avatars, one larger and one smaller, to represent a parent-child combination."
src="https://user-images.githubusercontent.com/586552/203213337-c7d0f683-4971-4ef3-b480-c4743b929634.png"
/>

## Usage

Use AvatarPair to display two avatars when one is secondary to the other.

## Options
Expand Down
8 changes: 5 additions & 3 deletions content/components/circle-badge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ export default ComponentLayout
Interested in contributing? Review the guidelines for <Link as={GatsbyLink} to="/guides/contribute/documentation#documenting-components">writing component documentation</Link> and open a pull request in our <Link as={GatsbyLink} to="https://github.com/primer/design">documentation repository.</Link>
</Note>

## Usage

Use circle badge to visually connect logos of third party services.
<br />

<img
width="960"
alt="Circle badge component displayed in small, medium, and large sizes"
src="https://github.com/primer/design/assets/586552/b60426b5-8f43-449b-8158-2b98221acce0"
/>

## Usage

Use circle badge to visually connect logos of third party services.
8 changes: 4 additions & 4 deletions content/components/counter-label.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ rails: https://primer.style/view-components/components/beta/counter
import ComponentLayout from '~/src/layouts/component-layout'
export default ComponentLayout

## Usage

Use counter label to add a count to navigational elements and buttons.

<img
width="960"
alt="A image showing two examples of buttons with counters"
src="https://user-images.githubusercontent.com/586552/205141782-bfe137b1-6d83-4b9d-bcdd-bcd1877f864b.png"
/>

## Usage

Use counter label to add a count to navigational elements and buttons.

## Accessibility

Always use counter label with adjacent text that provides supplementary information regarding what the count is for. For instance, Counter should be accompanied with text such as issues or pull requests.
4 changes: 2 additions & 2 deletions content/components/hidden-text-expander.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: HiddenTextExpander
description: Use HiddenTextExpander to indicate and toggle hidden text.
title: Hidden text expander
description: Hidden text expander indicates and toggles hidden text.
railsIds:
- Primer::Alpha::HiddenTextExpander
---
Expand Down

0 comments on commit ba464ea

Please sign in to comment.