Conversation
Updated the image description and removed redundant sections.
| - Project Team Error guidance | ||
| - [X] Project Team Page Details | ||
| - [X] Project Team Issue and PR details | ||
| - [ ] Project Team Solution |
There was a problem hiding this comment.
Please check this, since you are adding a solution
| - [ ] Project Team Solution | ||
| - [x] Credits/Authors | ||
|
|
||
| ## WAVE Error guidance |
There was a problem hiding this comment.
| ## 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` |
There was a problem hiding this comment.
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.` |
There was a problem hiding this comment.
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] |
There was a problem hiding this comment.
remove the extra line
- [INCLUDE Contributor N]
docs/known-issues-and-solutions/solutions-index/alert-skipped-heading-level.md
Show resolved
Hide resolved
docs/known-issues-and-solutions/solutions-index/alert-skipped-heading-level.md
Show resolved
Hide resolved
| #### 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. |
Creating PR since I'm the first developer updating new a11y docs.