Redocly / Redocly/redoc

Accessibility: Query parameters as list for beter readability

Open
#2,519 0 comments 0 reactions 0 assignees View on GitHub

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 'Query Parameter' section is defined as a table. Screen reader software for the blind encounters difficulties in reading it aloud. Our improvement suggestion for better readability through the software would be to use a list instead of a table.

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Query Parameter section in the TypeScript frontend and inspect how its current table is rendered. Confirm the intended list structure with the project's accessibility expectations; done means screen-reader users can read the query parameters more clearly without losing their information.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
accessibility, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.