microsoft / microsoft/vscode-wiki

Unclear instructions for Aria Labels on Accessibility Guidelines page

Open
#307 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
291
Forks
372
Avg merge
6m
Merged PRs (30d)
1

Description

In the Accessibility Guidelines.md page. The Aria Alerts section includes a weird sentence on how to deal with alerts.

In those cases you our helper method aria.alert to announce.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open Accessibility-Guidelines.md and read the Aria Alerts section around the sentence containing aria.alert. Correct the unclear wording so the instruction is grammatical and unambiguous, then confirm the rendered section communicates how alerts should be announced.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.