Skip to content

Commit d40642b

Browse files
committed
Docs: Add accessbility specific page
Adds an additional page to the developer handbook on accessibility in particular the landmark regions. Fixes #3217
1 parent b4ff7cf commit d40642b

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Accessibility
2+
3+
Accessibility documentation for developers working on the Gutenberg Project.
4+
5+
For more information on accessibility and WordPress see the [Make WordPress Accessibility Handbook](https://make.wordpress.org/accessibility/handbook/) and the [Accessibility Team section](https://make.wordpress.org/accessibility/).
6+
7+
## Landmark Regions
8+
9+
It is a best practice to include ALL content on the page in landmarks, so that screen reader users who rely on them to navigate from section to section do not lose track of content.
10+
11+
Read more regarding landmark design from W3C:
12+
13+
- [General Principles of Landmark Design](https://www.w3.org/TR/wai-aria-practices-1.1/#general-principles-of-landmark-design)
14+
- [ARIA Landmarks Example](https://www.w3.org/TR/wai-aria-practices/examples/landmarks/)
15+
- [HTML5 elements that by default define ARIA landmarks](https://www.w3.org/TR/wai-aria-practices/examples/landmarks/HTML5.html)

docs/manifest.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@
101101
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/designers-developers/developers/internationalization.md",
102102
"parent": "developers"
103103
},
104+
{
105+
"title": "Accessibility",
106+
"slug": "accessibility",
107+
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/designers-developers/developers/accessibility.md",
108+
"parent": "developers"
109+
},
104110
{
105111
"title": "Data Module Reference",
106112
"slug": "data",

docs/toc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
{"docs/designers-developers/developers/filters/autocomplete-filters.md": []}
1919
]},
2020
{"docs/designers-developers/developers/internationalization.md": []},
21+
{"docs/designers-developers/developers/accessibility.md": []},
2122
{"docs/designers-developers/developers/data/README.md": "{{data}}"},
2223
{"docs/designers-developers/developers/packages.md": "{{packages}}"},
2324
{"packages/components/README.md": "{{components}}"},

0 commit comments

Comments
 (0)