Skip to content

[Doc]: Add alt text to figures in documentation  #24309

Description

@story645

Documentation Link

No response

Problem

None of our images have alt-text and that's becoming a standard now and our communication's guidelines say we should add alt-text when the platform allows.

Suggested improvement

The steps involved in having a consistent way to add alt text to our docs are

code

docs

  • replace alt text guidelines in communication guidelines with a standalone documentation page on alt-text for visualization best practices, update links in communications and pull requests guidelines to post to it.
  • write tutorial on making accessible viz
  • document using alt_aria as part of and alt text and update the PR template w/ a nudge to use alt text
  • add alt text to gallery files: I do it here in order of visibility, but traffic is probably a better way to prioritize)
    • plot gallery - it feeds the home page gallery so is probably highest profile
    • tutorials - doesn't always have code for the images
    • gallery
    • narrative text
    • older whats news and anything missing from the above

Adding alt text is piles of work and probably would benefit from strategy and partnerships w/ classes/sprints or hiring someone depending on timeline.

Activity

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

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions