Skip to content

fix: added solution details#46

Open
ColinBuyck wants to merge 3 commits intomainfrom
2960-tdm-supporting-documentation
Open

fix: added solution details#46
ColinBuyck wants to merge 3 commits intomainfrom
2960-tdm-supporting-documentation

Conversation

@ColinBuyck
Copy link
Copy Markdown
Member

Creating PR since I'm the first developer updating new a11y docs.

- Project Team Error guidance
- [X] Project Team Page Details
- [X] Project Team Issue and PR details
- [ ] Project Team Solution
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please check this, since you are adding a solution

- [ ] Project Team Solution
- [x] Credits/Authors

## WAVE Error guidance
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
## WAVE Alert guidance

<!-- Author Instructions: Add a detailed explanation of the specific accessibility problem, including context about when/where it occurs, what elements are involved, and why it's problematic for assistive technology users -->
[INSERT CONTENT]

`The issues above were caused by a skip in sequential heading level within a page's html. For example, if a page had a <h1> and <h3>, but no <h2>. This is problematic for assistive technology users because heading levels serve as a table of contents for understanding the structure of information on a web page. When a heading level is skipped, a user may assume there is missing information or that there are no further heading levels to explore when they encounter a heading level with no content. It is a major break in expected behavior and is disruptive for a user's ability to understand a page quickly`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This paragraph should not be surrounded by a back tick. You can look at https://github.com/hackforla/accessibility/blob/main/docs/known-issues-and-solutions/solutions-index/error-broken-aria-reference.md for reference on formatting

<!-- Author Instructions: Add a few sentences describing the fix. "Why the Fix Works" comes later (see below). If there are lots of instructions required to explain the solution, include them in Developer Resources below -->
[INSERT CONTENT]

`This can be resolved by updated the heading levels so that no levels are skipped. In the example provided above, the <h3> heading should be updated to <h2>. In addition, we should double check that this update does not create a new skipped heading level for the rest of the page and if so, update accordingly.`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This paragraph should not be surrounded by a back tick. You can look at https://github.com/hackforla/accessibility/blob/main/docs/known-issues-and-solutions/solutions-index/error-broken-aria-reference.md for reference on formatting

- @experimentsinhonesty
- @Rabia2219
- @ColinBuyck
- [INCLUDE Contributor N]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

remove the extra line
- [INCLUDE Contributor N]

#### Why the Fix Works
<!-- Author Instruction: Add an explanation of how the code changes resolve the accessibility issue and why this approach was chosen -->
[INSERT CONTENT]
- This fix becuase it removes the gap in sequential heading levels within a single page.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

spelling: because

Copy link
Copy Markdown
Member

@Rabia2219 Rabia2219 left a comment

Choose a reason for hiding this comment

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

please see comments...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants