Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Poor readability of grey text on grey background in VU boxes #56

Open
marty-johnson59 opened this issue Nov 28, 2023 · 2 comments
Open
Labels
accessibility CSS Fix or addition to site CSS needed enhancement New feature or request

Comments

@marty-johnson59
Copy link
Contributor

marty-johnson59 commented Nov 28, 2023

Moving this issue over from the archived Antora repo (https://gitlab.khronos.org/vulkan/antora/-/issues/3 per @daniel-story). Note: there are some comments in the archived repo on this issue..

I'm not sure if this is the correct place for internal issues related to the new Vulkan Documentation Project Demo site, but I wanted to call attention to the somewhat poor contrast of text vs. background in the VU boxes on the new site. VUs are already notoriously dense in terms of both verbiage and actual information content, so I would like to suggest a lighter background color for VU boxes.

@oddhack
Copy link
Collaborator

oddhack commented Nov 29, 2023

Two points brought up in discussion this week:

  • This is a special case of the general accessibility question. Low contrast is an accessibility issue. We have some intention to hire an accessibility consultant as this is, broadly speaking, beyond our competency.
    • I've used the ANDI tool (https://www.ssa.gov/accessibility/andi/help/howtouse.html) with some success on the asciidoctor-generated specs. @outofcontrol also has a tool used for this sort of thing, though my attempt to run it on the enormous single-page Vulkan spec made that fall over and die - it will probably be fine for the Antora site pages, though.
  • While easily changed in the site CSS, also note Antora renders VU blocks differently than straight asciidoctor, which puts this type of block into a box, rather than using highlighting. Having some way to visually identify the VU blocks would help when making them collapsible, as we expect to eventually do. So just removing the gray-on-gray CSS would not accomplish that.

@oddhack oddhack added enhancement New feature or request accessibility CSS Fix or addition to site CSS needed labels Jan 29, 2024
@oddhack
Copy link
Collaborator

oddhack commented Jan 30, 2024

Fixed link to internal gitlab site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility CSS Fix or addition to site CSS needed enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants