Skip to content

Commit 1d59175

Browse files
Updated Documentation
1 parent e86e17e commit 1d59175

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

apps/docs/content/components/Hero/index.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default ComponentLayout
1717

1818
## Usage
1919

20-
Use the hero component to provide a title, description and action that introduces the main content of a page. The hero component is designed to be positioned at the top of a page and spans the full width of the viewport. Consider using the [CTA banner](/components/CTABanner) to replicate the content and actions in other parts of the page.
20+
Use the hero component to provide a title, description and action that introduces the main content of a page. The hero component is designed to be positioned at the top of a page and spans the full width of the viewport. Consider using the [CTA banner](/components/CTABanner) to replicate the content and actions in other parts of the page.
2121

2222
Both heading and description of the hero should be short and descriptive. Heading should be not be longer than 2 lines, and description should be no longer than 3-4 lines.
2323

@@ -60,11 +60,16 @@ Hero elements can be aligned to the start or center of the page. By default, the
6060
<Dont>
6161
<img src="https://github.com/primer/brand/assets/912236/1f56d40e-c3aa-4955-aa8f-a4748e9fe149" />
6262
<Caption>
63-
Don't use center alignment if the background interfere with the legibility of the content.
63+
Don't use center alignment if the background interfere with the legibility
64+
of the content.
6465
</Caption>
6566
</Dont>
6667
</DoDontContainer>
6768

69+
## Accessibility
70+
71+
Centering text may negatively impact legibility making text difficult to read. While we support this variant if possible use the left-aligned design to improve readability for more users.
72+
6873
## Related components
6974

7075
- [Section intro](/components/SectionIntro): To provide a title, description and a link to a new section in the page.

0 commit comments

Comments
 (0)