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

Add alt text to all main documentation pages #672

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

maxitg
Copy link
Owner

@maxitg maxitg commented Jan 27, 2025

Changes

  • Add alt text to all images in the main (not Yellowstone) documentation.
  • Replace an image in CausalDensityDimension.md with TeX.

Comments

  • This is needed to update markdownlint-cli to the latest version 0.44.0 without disabling rules.
  • I tried to describe images in a way that the pages can be understood within seeing the images. In some cases that involved explicitly listing events in a token-event graph, which made the alt text pretty long. However, it's difficult to make them understandable otherwise. If you have a better idea, please let me know.

Examples

It is now possible to read documentation in links:

Screenshot 2025-01-26 at 22 34 10

This change is Reviewable

@maxitg maxitg added the documentation Adds or changes documentation for existing functionality label Jan 27, 2025
@maxitg maxitg changed the title Add alt text to all documentation pages Add alt text to all main documentation pages Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Adds or changes documentation for existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant