Skip to content

docs(skill): add email accessibility guidance to skill#3550

Closed
hermesresend wants to merge 2 commits into
resend:canaryfrom
hermesresend:skill-accessibility-guidance
Closed

docs(skill): add email accessibility guidance to skill#3550
hermesresend wants to merge 2 commits into
resend:canaryfrom
hermesresend:skill-accessibility-guidance

Conversation

@hermesresend
Copy link
Copy Markdown
Contributor

Updates the react-email agent skill so agents using it produce accessible emails by default, matching the new accessibility defaults shipped in the latest release and the findings of the Email Markup Consortium's 2026 accessibility report (0.002% pass rate across 376,348 emails).

What changes

skills/react-email/SKILL.md

  • Fixes the alt-text rule. The old line was "always include alt text," which is wrong for decorative images and conflicts with the new <Img alt=""> default.
  • Adds an Accessibility subsection that splits the responsibility cleanly: structural defaults React Email gives you for free (lang/dir on Body, alt="" on Img, role="presentation" on Markdown tables, title from Preview), versus the content choices the author still owns (heading hierarchy, descriptive alt + link text, 4.5:1 contrast, locale handling).

skills/react-email/references/COMPONENTS.md

  • <Img> props: notes that alt defaults to "" instead of marking it as required (it isn't anymore), and rewrites the best practices to distinguish meaningful vs. decorative images.
  • <Section> docs: notes that layout components (<Section>, <Row>, <Container>, <Markdown> tables) render role="presentation" by default so screen readers don't announce them as data tables, and reminds authors to add it themselves on any raw <table> they drop in.

skills/react-email/references/STYLING.md

  • Aligns the image best-practices block with the new alt-text guidance and adds a decorative-image example.

Why

Agents using this skill generate the templates. If the skill still says "always include alt text," they'll plaster alt="image" on decorative spacers and clutter every screen reader. Better to teach the right rule once.

A companion PR adds a full accessibility reference to the email-best-practices skill: resend/email-best-practices#16

Updates the react-email skill so agents using it produce accessible
emails by default:

- SKILL.md: rewrites the alt-text rule (no more 'always include alt text'
  which is wrong for decorative images) and adds an Accessibility section
  covering what React Email handles for free vs. what the author still
  has to do (headings, link copy, contrast, locale).
- COMPONENTS.md: notes that <Img> defaults to alt="", clarifies meaningful
  vs. decorative image guidance, and documents that <Section>, <Row>,
  <Container>, and <Markdown> tables render role="presentation" by default.
- STYLING.md: aligns alt-text guidance and adds a decorative-image example.

Aligns with the new <https://emailmarkup.org/en/reports/accessibility/2026/|EMC 2026 accessibility report> findings and the
react-email defaults shipped in the latest release.
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 27, 2026

⚠️ No Changeset found

Latest commit: 3d114b4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 27, 2026

@hermesresend is attempting to deploy a commit to the resend Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 3 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Auto-approved: These changes only update documentation in markdown files to improve accessibility guidance for the react-email skill, with no code or logic changes, making them safe to auto-approve.

Re-trigger cubic

Omitting the alt attribute is not equivalent to alt="". Some screen
readers announce the filename when alt is missing, so decorative
images must carry an explicit empty alt. Updates examples and wording
to make this unambiguous.
@christina-de-martinez christina-de-martinez changed the title docs(skill): add email accessibility guidance to react-email skill docs(skill): add email accessibility guidance to skill May 27, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

0 issues found across 3 files (changes from recent commits).

Auto-approved: These documentation updates improve accessibility guidance for the react-email skill by correcting alt-text rules and adding structured recommendations, with no changes to code, configuration, or business logic.

Re-trigger cubic

@christina-de-martinez
Copy link
Copy Markdown
Collaborator

Closed in favor of #3551

@hermesresend
Copy link
Copy Markdown
Contributor Author

Superseded by #3551 (same commits rebased onto an upstream branch by @christina-de-martinez). Closing this one to keep review in one place.

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