prestodb / prestodb/prestodb.github.io

New docs website has some accessibility issues

Open
#270 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
6
Forks
70
Avg merge
1d 14h
Merged PRs (30d)
3

Description

I noticed that the text in the header is very difficult to read due to the low contrast and ran it through a basic a11y tester (axe devtools). Many of these may have also existed in the previous version.

There's two things which would be very easy to fix:

  • A few elements with insufficient contrast
  • Links are not distinguished except by color

Some other issues which are slightly more involved to fix:

  • Deprecated aria roles stemming from sphinx (doc-biblioentry, doc-backlist)
  • Search area includes a scroll wrap even when there's thing possible to scroll

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

Start by running axe DevTools against the new docs website and inspect the header contrast, link styling, deprecated Sphinx ARIA roles, and search-area scroll wrapper described in the issue. Done means the reported accessibility problems are addressed and the site passes the relevant checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
accessibility, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.