cityofaustin / cityofaustin/techstack

Heading levels in guides

Open
#3,049 2 comments 0 reactions 0 assignees View on GitHub
a11y Bug Reported Content Type: Guides Janis Alpha P4 Team: Dev
Dominant language
No language data
Stars
11
Forks
3
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
Headings in guides are problematic—titles for pages that are dynamically getting pulled in are styling as H2, and so is the next heading level down. (See screenshot 3.) This makes sense on a standalone page, but not within a guide, which has two layers of headings above it—the guide title (H1), and the section title (which seems to be styling as an H1 but semantically doesn't make sense to me)

![image](https://user-images.githubusercontent.com/5839508/65641078-76644900-dfb1-11e9-8014-da3c8e97a163.png)
versus
![image](https://user-images.githubusercontent.com/5839508/65641100-867c2880-dfb1-11e9-89d4-23677e81d3e1.png)
![image](https://user-images.githubusercontent.com/5839508/65641115-8da33680-dfb1-11e9-8f2e-a1de068bae78.png)

Notes from https://github.com/cityofaustin/techstack/issues/2599#issuecomment-522774454:
- this is like a blog. Investigate how nested H2 tags work for screenreader
- instead of `div`, could use an `article`. What's ambiguous is article vs. section tag. #1257 is related to semantic html

**Acceptance criteria**
- [ ] tbd

**URL**

**To Reproduce**

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Current behavior**

**Expected behavior**

**Screenshots**

**Device**

**Browser**

**Additional context**

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.