Skip to content

Conversation

@huangkevin-apr
Copy link

[中文版模板 / Chinese template]

🤔 This is a ...

  • New feature
  • Bug fix
  • Site / documentation update
  • Demo update
  • TypeScript definition update
  • Bundle size optimization
  • Performance optimization
  • Enhancement feature
  • Internationalization
  • Refactoring
  • Code style optimization
  • Test Case
  • Branch merge
  • Other (about what?)

🔗 Related issue link

N/A - Accessibility improvement identified through IBM Equal Access Accessibility Checker

💡 Background and solution

When running IBM Accessibility Checker (Version 4.0.8) on the homepage, 3 violations were identified in the documentation. The discussion group QR code images in README.md and documentation files were missing alt attributes, making them inaccessible to screen reader users.

image

Why is this important?

When an image contains important information, providing a text alternative makes the same information accessible through assistive technologies, such as a Braille display. When an image is decorative or redundant, providing correct markup allows assistive technologies to ignore or not repeat the information.

Solution:

Added descriptive alt attributes to all 3 discussion group images:

  • English documentation: alt="ahooks discussion group 1/2/3"
  • Chinese documentation: alt="ahooks 交流群1/2/3"

This ensures that users relying on assistive technologies can understand these are QR codes for joining discussion groups.

Fix Before:
image

Fix After:
image

📝 Changelog

Language Changelog
🇺🇸 English Add alt attributes to discussion group QR code images for better accessibility
🇨🇳 Chinese 为交流群二维码图片添加 alt 属性以提升可访问性

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • TypeScript definition is updated/provided or not needed
  • Changelog is provided or not needed

@CLAassistant
Copy link

CLAassistant commented Jan 8, 2026

CLA assistant check
All committers have signed the CLA.

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.

2 participants