Skip to content

address docs accessibility issues#3205

Merged
zingale merged 1 commit into
AMReX-Astro:developmentfrom
zingale:docs_accessible
Feb 5, 2026
Merged

address docs accessibility issues#3205
zingale merged 1 commit into
AMReX-Astro:developmentfrom
zingale:docs_accessible

Conversation

@zingale

@zingale zingale commented Feb 5, 2026

Copy link
Copy Markdown
Member

fix color contrast
add back link underlining

PR summary

PR motivation

PR checklist

  • test suite needs to be run on this PR
  • this PR will change answers in the test suite to more than roundoff level
  • all newly-added functions have docstrings as per the coding conventions
  • the CHANGES file has been updated, if appropriate
  • if appropriate, this change is described in the docs

fix color contrast
add back link underlining
@zingale

zingale commented Feb 5, 2026

Copy link
Copy Markdown
Member Author

Here's a build of the docs with these changes:

image

@zingale
zingale merged commit c940047 into AMReX-Astro:development Feb 5, 2026
26 checks passed
@zingale
zingale deleted the docs_accessible branch February 5, 2026 15:59
zingale added a commit that referenced this pull request Feb 5, 2026
fix color contrast
add back link underlining
@Myndex

Myndex commented Mar 29, 2026

Copy link
Copy Markdown

Underlining by default can be anti-accessible in many cases, as it can significantly interfere with readability. Underlines in blocks of body text in particular.

Underlines are far from "best practice". Like most things related to accessibility, user preference is king.

Here is a link to a draft of a white paper and related discussion we are working on:

Myndex/SAPC-APCA#65

In short, the context of where the underline is, and the white space and density of the text, all play a role here.

Cheers,

Andrew Somers
Director of Research
Inclusive Reading Technologies
https://readtech.org/ARC/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants