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 Yellowstone documentation pages #673

Open
wants to merge 2 commits 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 Yellowstone documentation.

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 the documentation in links:
Screenshot 2025-01-26 at 22 38 23


This change is Reviewable

@maxitg maxitg added the documentation Adds or changes documentation for existing functionality label Jan 27, 2025
@maxitg maxitg force-pushed the feature/alt-text-yellowstone-docs branch 3 times, most recently from 929575b to b5c3f8f Compare January 31, 2025 08:37
@maxitg maxitg marked this pull request as ready for review January 31, 2025 08:38
@maxitg maxitg requested review from taliesinb and daneelsan January 31, 2025 08:39
@maxitg maxitg self-assigned this Jan 31, 2025
daneelsan
daneelsan previously approved these changes Feb 2, 2025
<img src="/Documentation/Images/MaxDestroyerEventsInfinity.png" width="478.2">
<img src="/Documentation/Images/MaxDestroyerEventsInfinity.png"
width="478.2"
alt="Out[] = ... {1, 2} -> {3 (* 1 + 2 *)}, {2, 1} -> {3 (* 2 + 1 *)}, {1, 3 (* init *)} -> {4}, <<3>> ...">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really sure there is a better alternative than this.
Perhaps the text could specify what the head of the result is, in this case Graph, but this is good enough.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, I added heads everywhere.

Copy link
Owner Author

@maxitg maxitg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 17 files reviewed, 1 unresolved discussion (waiting on @daneelsan and @taliesinb)

<img src="/Documentation/Images/MaxDestroyerEventsInfinity.png" width="478.2">
<img src="/Documentation/Images/MaxDestroyerEventsInfinity.png"
width="478.2"
alt="Out[] = ... {1, 2} -> {3 (* 1 + 2 *)}, {2, 1} -> {3 (* 2 + 1 *)}, {1, 3 (* init *)} -> {4}, <<3>> ...">
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, I added heads everywhere.

@maxitg maxitg force-pushed the feature/alt-text-yellowstone-docs branch from ca75830 to 87a9221 Compare February 9, 2025 04:00
@maxitg maxitg requested a review from daneelsan February 9, 2025 04:15
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.

2 participants