fix(a11y): descriptive image alt text in docs and generated tutorials#216
Open
MohammedAnasNathani wants to merge 1 commit into
Open
fix(a11y): descriptive image alt text in docs and generated tutorials#216MohammedAnasNathani wants to merge 1 commit into
MohammedAnasNathani wants to merge 1 commit into
Conversation
- README badges: CI tests status, Contributor count vs avatars
- examples/README: describe what each demo shows, not the filename
- tutorial.md.j2: interpolate {{ title }} into the demo.gif alt so every
generated tutorial is unique for screen readers and SEO
Closes alphacrack#197
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #197 — first accessibility-focused fix on the board.
(a) Hand-written docs
README.mdCI badgetestsCI tests statusContributorsContributor countContributors(duplicate)Contributor avatarsexamples/README.mdself-demoexamples/README.mdtoolhive(b) Generated tutorials (the product bug)
templates/tutorial.md.j2hardcoded the same alt string for every repo:Now:
titleis already passed to the template; guide-only runs still get a real title (no empty/stray dashes).Tests
demo.gifsohas_videois true, assert alt contains the tutorial titlerepo_url="") still renders sensible altGrounding: none — alt is prose/markup only; no command path changed.
Test plan
pytest tests/test_tutorial.py -k demo_alt(2 passed)