Fixes DOC-2073 #443
Merged
Fixes DOC-2073 #443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👍 |
| The purpose of this guide is to provide a reference for documentation standards | ||
| used in edX technical publications. Its intended audience is members of the | ||
| edX documentation team, other edX employees, and translation teams and open | ||
| source contributors around the world. |
|
Great, thank you. One question. 👍 |
| .. note:: With regard to blindness, I feel it is important to drive home | ||
| the fact that if you do not vocalize unspoken visual events that are important | ||
| to understanding the video, you will trigger a requirement to provide Audio | ||
| Descriptions, which is both expensive and time consuming. |
There was a problem hiding this comment.
Is there a reason "Audio Descriptions" is capitalized?
There was a problem hiding this comment.
no reason at all. should probably be lower-cased. We may consider linking to definition though: http://www.w3.org/TR/WCAG20/#audiodescdef
|
A few nits - otherwise 👍 |
|
@cptvitamin are you ok with the edits that @srpearce and @mhoeber suggest? or should I take out the line crediting you for this work? |
|
These comments are good. I definitely think first person should be removed. |
@mhoeber @catong @srpearce this is my decathlon project for the week. See https://openedx.atlassian.net/browse/DOC-2073. @cptvitamin I have very lightly edited your google doc to include it in our style guide, most notably by adding some additional subheaders.
lamagnifica
force-pushed
the
ahodges/a11y_styleguide
branch
from
c660102
to
25d9d65
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@mhoeber @catong @srpearce this is my docathon project for the week.
See https://openedx.atlassian.net/browse/DOC-2073.
@cptvitamin I have very lightly edited your google doc to include it in
our style guide, most notably by adding some additional subheaders.