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

Create accessibility menu page #227

Merged
merged 25 commits into from Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
426babd
create accessibility menu page
ichelsea Mar 9, 2022
7441e09
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
310ae3d
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
c706470
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
6f9000d
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
34e2ea3
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
6181bb2
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
7570133
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
15bcaca
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
5cdcc9e
Update content/accessibility/index.mdx
ichelsea Mar 10, 2022
84e5f73
Update content/accessibility/index.mdx
yaili Mar 11, 2022
25be406
Update content/accessibility/index.mdx
yaili Mar 11, 2022
88faf01
Update content/accessibility/index.mdx
yaili Mar 11, 2022
64bc231
change navigation order of accessibility links
ichelsea Mar 11, 2022
a0848b8
Update index.mdx
ichelsea Mar 11, 2022
3437a71
Making links a comment until I add the links page
ichelsea Mar 11, 2022
6f3518e
Merge branch 'main' of https://github.com/primer/design into accessib…
ichelsea Mar 22, 2022
f17efc0
menu updates, rearranging
ichelsea Mar 22, 2022
6b4ad97
trying section titles in the menu
ichelsea Mar 22, 2022
1c26211
nevermind..
ichelsea Mar 22, 2022
b36d2f1
headings the right way
ichelsea Mar 25, 2022
3d29413
Updates to menu page and nav listing
ichelsea Mar 30, 2022
b46e7b6
menu page descriptions
ichelsea Mar 30, 2022
cc1e0a8
Apply suggestions from yaili's code review
ichelsea Mar 31, 2022
ec771e3
Fixed links, ran thru spell check
ichelsea Mar 31, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
66 changes: 66 additions & 0 deletions content/accessibility/index.mdx
@@ -0,0 +1,66 @@
---
title: Accessibility
---

import {Grid, Flex, Box, Link, Text, Label} from '@primer/components'

<Grid gridTemplateColumns="1fr" gridGap={4}>


<Grid gridTemplateColumns="1fr" gridGap={4}>
<h2>General</h2>
<div>
<Link href="/design/accessibility/accessibility-at-github" fontWeight="bold">Accessibility at GitHub</Link>
<Box as="p">Get started with accessibility at GitHub.</Box>
</div>
<div>
<Link href="/design/accessibility/guidelines" fontWeight="bold">Guidelines</Link>
<Box as="p">Basic guidelines for designers when creating or updating features.</Box>
</div>
<div>
<Link href="/design/accessibility/tools" fontWeight="bold">Tools</Link>
<Box as="p">A selection of tools to help designers create accessible designs.</Box>
</div>
</Grid>


<Grid gridTemplateColumns="1fr" gridGap={4}>
<h2>Specific</h2>
<div>
<Link href="/design/accessibility/alternative-text-for-images" fontWeight="bold">Alternative text for images</Link>
<Box as="p">Alternative text on images allows assistive technology like screen readers to understand the purpose of an image on a page or allow them to skip it if purely decorative. </Box>
</div>
<div>
<Link href="/design/accessibility/announcements" fontWeight="bold">Assistive technology announcements</Link>
<Box as="p">Events like toasts and status messages are visually communicated to GitHub users. Making sure those announcements are read via assistive technology allows users with low or no vision to get that status information.</Box>
</div>
<div>
<Link href="/design/accessibility/button-purpose" fontWeight="bold">Describing a button’s purpose</Link>
<Box as="p">Labeling buttons properly let's users know what will happen when they activate the control, lessens errors, and increases confidence.</Box>
</div>
<div>
<Link href="/design/accessibility/focus-management" fontWeight="bold">Focus management</Link>
<Box as="p">Managing focus within a page or application is essential for users to successfully navigate, complete actions, and understand where they are.</Box>
</div>
<div>
<Link href="/design/accessibility/headings" fontWeight="bold">Headings</Link>
<Box as="p">Headings play a critical role in communicating the structure of a page. Find out why they're critical and how to create an accessible hierarchy in your pages.</Box>
</div>
<div>
<Link href="/design/accessibility/links" fontWeight="bold">Links</Link>
<Box as="p">Links help us navigate a website. Learn how to style links appropriately to keep them usable by all.</Box>
</div>
<div>
<Link href="/design/accessibility/semantic-html" fontWeight="bold">Semantic HTML</Link>
<Box as="p">Understand when and how to use semantic HTML to improve the experience of the largest number of users possible.</Box>
</div>
<div>
<Link href="/design/accessibility/text-resize-and-respacing" fontWeight="bold">Text resize and respacing</Link>
<Box as="p">People on the web should be able to resize text to improve legibility without blocking or obscuring any other part of the UI.</Box>
</div>
<div>
<Link href="/design/accessibility/tooltip-alternatives" fontWeight="bold">Tooltip alternatives</Link>
<Box as="p">Most UI cases don't call for tooltips. Learn some alternative methods to use in place of tooltips.</Box>
</div>
</Grid>
</Grid>
2 changes: 1 addition & 1 deletion content/index.mdx
Expand Up @@ -11,7 +11,7 @@ Primer's interface guidelines are a collection of principles, standards, and usa

The fundamental parts of the design system that underpin all GitHub interfaces, such as color and typography.

## [Accessibility](https://primer.style/design/accessibility/accessibility-at-github)
## [Accessibility](https://primer.style/design/accessibility)

Standards, guidelines, and tools to design accessible GitHub interfaces.

Expand Down
13 changes: 13 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -16,7 +16,8 @@
"gatsby": "^2.32.13",
"gatsby-plugin-alias-imports": "^1.0.5",
"react": "16.9.x",
"react-dom": "16.9.x"
"react-dom": "16.9.x",
"yarn": "^1.22.18"
},
"private": true
}
26 changes: 11 additions & 15 deletions src/@primer/gatsby-theme-doctocat/nav.yml
Expand Up @@ -8,36 +8,32 @@
- title: Content
url: /foundations/content
- title: Accessibility
url: /accessibility/accessibility-at-github
url: /accessibility
children:
- title: Accessibility at GitHub
url: /accessibility/accessibility-at-github
- title: Focus management
url: /accessibility/focus-management
- title: Guidelines
url: /accessibility/guidelines
- title: Tools
url: /accessibility/tools
- title: Tooltip alternatives
url: /accessibility/tooltip-alternatives
- title: Semantic HTML
url: /accessibility/semantic-html
- title: Headings
url: /accessibility/headings
- title: Alternative text for images
url: /accessibility/alternative-text-for-images
- title: Text resize and respacing
url: /accessibility/text-resize-and-respacing
- title: Assistive technology announcements
url: /accessibility/announcements
- title: Focus management
url: /accessibility/focus-management
- title: Describing a button’s purpose
url: /accessibility/button-purpose
- title: Focus management
url: /accessibility/focus-management
- title: Headings
url: /accessibility/headings
- title: Links
url: /accessibility/links
- title: Tools
url: /accessibility/tools
- title: Semantic HTML
url: /accessibility/semantic-html
- title: Text resize and respacing
url: /accessibility/text-resize-and-respacing
- title: Tooltip alternatives
url: /accessibility/tooltip-alternatives
- title: UI patterns
url: /ui-patterns
children:
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
Expand Up @@ -16027,6 +16027,11 @@ yargs@^16.1.0:
y18n "^5.0.5"
yargs-parser "^20.2.2"

yarn@^1.22.18:
version "1.22.18"
resolved "https://registry.yarnpkg.com/yarn/-/yarn-1.22.18.tgz#05b822ade8c672987bab8858635145da0850f78a"
integrity sha512-oFffv6Jp2+BTUBItzx1Z0dpikTX+raRdqupfqzeMKnoh7WD6RuPAxcqDkMUy9vafJkrB0YaV708znpuMhEBKGQ==

yeast@0.1.2:
version "0.1.2"
resolved "https://registry.yarnpkg.com/yeast/-/yeast-0.1.2.tgz#008e06d8094320c372dbc2f8ed76a0ca6c8ac419"
Expand Down