Skip to content

Commit 3a8001e

Browse files
committed
Add notes on accessibility
1 parent 24cddd3 commit 3a8001e

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ To update the website, simply commit your changes to the appropriate file.
66
The changes will be automatically deployed to the live website
77
at [https://ions.berkeley.edu](https://ions.berkeley.edu), typically within 5-10 minutes.
88

9+
## Website structure
10+
911
Here are some of the important files:
1012

1113
### Global website layout
@@ -29,7 +31,24 @@ Here are some of the important files:
2931
- SQIP: [research/surface-treatment/index.md](research/surface-treatment/index.md)
3032
- STAQ: [research/staq/index.md](research/staq/index.md)
3133

32-
### Details
34+
## Accessibility
35+
36+
We have a responsibility to the scientific community (as well as to the university and the state of California) to comply with basic web accessibility standards. This means ensuring the site is usable by vision-impaired, hearing-impaired, and motor-impaired users.
37+
38+
After making changes, *please* verify that the WAVE report for your new content shows no errors:
39+
1. Go to https://wave.webaim.org/report#/ions.berkeley.edu.
40+
1. Navigate to the page you changed.
41+
1. If there are any errors, fix them.
42+
43+
If you made changes to navigation (such as the global menu), please ensure that keyboard accessibility still works. To verify this, instead of using a mouse, use "Tab" on your keyboard to cycle through the page. Ensure that all of the links on the page can be accessed.
44+
45+
Some tips to avoid the most common issues:
46+
1. Use standard Markdown syntax when possible. It's easier to read, easier to edit in the future, and less likely to introduce accessibility problems.
47+
1. Every image must have "alt" text. This should describe what is in the image. Don't just repeat the figure caption here. Imagine how you would describe the image to someone who cannot see it.
48+
1. When you must use HTML elements, choose the appropriate tags. Use `<h2>`, `<h3>`, etc. for headings and sub-headings. Use `<figure>` and `<figcaption>` for illustrations. This helps screen readers and other software interpret the page structure in a sensible way.
49+
1. If you are adding content with sound (such as video), it *must* have captions. Consider using YouTube, which can auto-generate captions.
50+
51+
## Details
3352

3453
This website is hosted using [GitHub Pages](https://docs.github.com/en/github/working-with-github-pages).
3554

0 commit comments

Comments
 (0)