search

Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
38 stars 81 forks source link

Add Image checker for images' alt text and HTML tags #2349

Closed arnaucasau closed 14 hours ago

arnaucasau commented 1 day ago

This pull request adds an image checker to ensure all images have an alt text defined, which is crucial for accessibility, and that we don't have any <img> HTML tag. The output of the check shows the file name that contains invalid images and the images' names. Ex:

Error in file 'docs/guides/custom-transpiler-pass.ipynb':
    - The image '/images/guides/custom-transpiler-pass/DAG.png' does not have alt text.

Invalid images found 💔 See https://github.com/Qiskit/documentation#images for instructions.

The PR builds on the work done by @shraddha-aangiras on https://github.com/Qiskit/documentation/pull/1800. I have made some changes to simplify the code and incorporated @eric-arellano's feedback. Thank you both for the work you've done!

Closes https://github.com/Qiskit/documentation/issues/1651

qiskit-bot commented 1 day ago

One or more of the following people are relevant to this code:

review-notebook-app[bot] commented 1 day ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB