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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): better alt text, add toggleable list of companies/projects that use Renovate #29022

Merged

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented May 13, 2024

Changes

  • Improve alt text for images
  • Add list of companies and projects that use Renovate, collapsed by default, works well with screenreaders

Context

I used Apple's screenreader (VoiceOver) to read our readme. The plain text works great, but currently the images and badges are confusing. I think we can improve things by clearly labeling our badges and images, so the screenreader can say what it contains.

My goal is to:

  • Have screenreaders read the content of images
  • Explain that some images are actually badges
  • Be more accessible for people who need screenreaders or otherwise need alt text

Changes after testing with VoiceOver

My new badge alt text for the badge was more confusing than the old style. So I'm reverting to the old style, with one minor improvement. The badge is a decorative element. It's not really important to know it's a badge. The content and meaning of the badge is covered by the alt text anyways.

The collapsible list of companies that use Renovate bot, works really well! 馃コ This means we can:

  • keep the social proof image with all 20 companies in it
  • have a short but descriptive alt text for the image
  • hide the long list by default, so it's not breaking the visual layout for those who can see
  • have a long list in plain text for those who need it, like screen reader users
  • get the plain-text benefits of a list

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose marked this pull request as ready for review May 18, 2024 17:21
@HonkingGoose HonkingGoose changed the title docs(readme): add descriptive alt text to images and badges docs(readme): better alt text, add toggleable list of companies/projects that use Renovate May 18, 2024
@rarkins rarkins added this pull request to the merge queue May 19, 2024
Merged via the queue into renovatebot:main with commit f8f5184 May 19, 2024
39 of 53 checks passed
@HonkingGoose HonkingGoose deleted the docs/readme-add-descriptive-alt-text branch May 19, 2024 07:05
@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 37.368.7 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

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.

None yet

3 participants