ROCm / ROCm

AMD ROCm™ Software - GitHub Home

Home Page:https://rocm.docs.amd.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Documentation]: Card Title Images are not accessible

Maetveis opened this issue · comments

Description of errors

The titles for the "cards" are images with text. Alternative text is not provided. This is very bad for screen readers and search engines.

Ideally the text should be in HTML and only the background should be an image. This would also make the site more printer friendly. Sphinx design allows custom css classes to be applied to elements that should make this fairly straightforward
At the very least description of these images need to be provided.

As an extra comment these images are quite large raster images, it would be nice to replace them with vector if possible graphics with smaller size.

Attach any links, screenshots, or additional evidence you think will be helpful.

image
image

Additional reference: https://sphinx-design.readthedocs.io/en/latest/cards.html#card-images

Example

:img-background: images/particle_background.jpg
:class-card: sd-text-black
:img-alt: my text
commented

@Maetveis I've started this PR: #2910. Feel free to add your suggestions here...I was not able to get the text to overlay my image, which is why I opted for the existing approach. But if you're able to make that happen, I'm all for it.

I think a good approach would be to have a custom CSS classes for these background banner images. Would you be able to share the source images without the text? If you don't want to upload publicly then you can also send it by e-mail. I could add them to rocm-docs-core.

I see that in #2910 you changed them to use jpg, what format are these originally?