Inaccurate heading hierarchy
Open
Nobody has claimed this yet.
Type: Enhancement
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
The header hierarchy when adding authorizations isn't well done (h2 for the title of the operation, then h5 for the authorizations then h3 for the responses)
Describe the solution you'd like
Change authorizations header to h3
Describe alternatives you've considered
Additional context
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 locating the TypeScript component that renders the authorizations section in the Redoc documentation UI. Compare its heading level with the operation title and responses; done when the authorizations heading uses h3 and the hierarchy is consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- accessibility, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100