Skip to content

docs(multiple): revise and expand a11y docs #23581

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 16, 2021
Merged

docs(multiple): revise and expand a11y docs #23581

merged 1 commit into from
Sep 16, 2021

Conversation

jelbourn
Copy link
Member

This change updates the accessibility docs for 21 components for
correctness, comprehensiveness, and clarity.

I have intentionally omitted several other components either because
they're being worked on by someone else or have significant changes
pending.

cc @zarend @amysorto

@jelbourn jelbourn added Accessibility This issue is related to accessibility (a11y) docs This issue is related to documentation merge safe target: patch This PR is targeted for the next patch release labels Sep 14, 2021
@google-cla google-cla bot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Sep 14, 2021
crisbeto
crisbeto approved these changes Sep 14, 2021
View reviewed changes
Copy link
Member

@crisbeto crisbeto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with some nits.

@aikithoughts
Copy link

I've added @TMDavisGoogle to provide an edit pass on this content. Please give her a day or two to review.

TMDavisGoogle
TMDavisGoogle reviewed Sep 15, 2021
View reviewed changes
TMDavisGoogle
TMDavisGoogle reviewed Sep 15, 2021
View reviewed changes
@jelbourn
docs(multiple): revise and expand a11y docs
031c602 
This change updates the accessibility docs for 21 components for
correctness, comprehensiveness, and clarity.

I have intentionally omitted several other components either because
they're being worked on by someone else or have signifcant changes
pending.
@jelbourn jelbourn added the action: merge The PR is ready for merge by the caretaker label Sep 15, 2021
twerske
twerske reviewed Sep 15, 2021
View reviewed changes
src/material/tabs/tabs.md
@@ -85,22 +85,36 @@ duration can be configured globally using the `MAT_TABS_CONFIG` injection token.
"region": "slow-animation-duration"}) -->

### Accessibility
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: space needed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean the blank line?

@twerske
Copy link
Contributor

twerske commented Sep 16, 2021

out of scope, but have we thought about moving these to outside the API tab or making them more searchable for SEO and generally for developers looking at components?

@jelbourn
Copy link
Member Author

@twerske these sections all live in the Overview tab for each component:
https://material.angular.io/components/icon/overview#accessibility

Did you have something in mind for SEO? AFAIK it should be indexed the same as the rest of the content.

@wagnermaciel wagnermaciel merged commit 7c33276 into angular:master Sep 16, 2021
wagnermaciel pushed a commit that referenced this pull request Sep 16, 2021
@jelbourn @wagnermaciel
docs(multiple): revise and expand a11y docs (#23581)
3326fb6 
This change updates the accessibility docs for 21 components for
correctness, comprehensiveness, and clarity.

I have intentionally omitted several other components either because
they're being worked on by someone else or have signifcant changes
pending.

(cherry picked from commit 7c33276)
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Oct 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@twerske twerske twerske left review comments

@TMDavisGoogle TMDavisGoogle TMDavisGoogle left review comments

@crisbeto crisbeto crisbeto approved these changes

@aikithoughts aikithoughts Awaiting requested review from aikithoughts

@andrewseguin andrewseguin Awaiting requested review from andrewseguin

@devversion devversion Awaiting requested review from devversion

@mmalerba mmalerba Awaiting requested review from mmalerba

Assignees
No one assigned
Labels
Accessibility This issue is related to accessibility (a11y) action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement docs This issue is related to documentation target: patch This PR is targeted for the next patch release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jelbourn @aikithoughts @twerske @crisbeto @TMDavisGoogle @wagnermaciel