Headings are not hierarchical
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 245
- Forks
- 80
- Avg merge
- 10h 46m
- Merged PRs (30d)
- 2
Description
When reading the spec, I notice that the table of contents is fine, but all headings are h1. This makes navigation harder for people who use them (blind people for example), as we can't skip to the next section without round trips to the TOC (I can only skip to the next heading, as they have the same level). Two possible solutions:
- Put the headings of the spec in a hierarchical order (section 1 is h1, 1.1 is h2, etc.); or
- Postprocess the code of epmarkup to change the heading levels and make them hierarchical, as it's already done in the TOC.
Of course, the end result will be the same.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how epmarkup generates spec headings and how the table of contents derives its hierarchy. Compare the two proposed approaches, then verify that section 1/1.1-style structure produces nested heading levels and preserves accessible navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- accessibility, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100