Skip to content

docs: make alt text and a11y support more visible#9

Merged
kmelve merged 1 commit intomainfrom
docs/improve-a11y-docs
Feb 6, 2026
Merged

docs: make alt text and a11y support more visible#9
kmelve merged 1 commit intomainfrom
docs/improve-a11y-docs

Conversation

@kmelve
Copy link
Contributor

@kmelve kmelve commented Feb 6, 2026

Summary

  • Update Getting Started example to use { src, alt } objects instead of plain strings, so alt text is the first thing new users see
  • Add note explaining both input formats (string vs object with alt)
  • Add alt={logo.alt} to the hook example
  • Expand renderImage docs to explain it receives all <img> attributes and show how to spread extra props like loading and decoding

Prompted by feedback that the a11y support wasn't obvious enough in the docs.

Test plan

  • Verify README renders correctly on GitHub

🤖 Generated with Claude Code

@vercel
Copy link

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
react-logo-soup Ready Ready Preview, Comment Feb 6, 2026 7:42pm

Request Review

Update examples to use { src, alt } objects instead of plain strings,
add alt to hook example, and expand renderImage docs to show how to
pass extra img attributes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kmelve kmelve force-pushed the docs/improve-a11y-docs branch from ad943b5 to 1ec330a Compare February 6, 2026 19:42
@kmelve kmelve merged commit 3abb8b5 into main Feb 6, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant