Skip to content

docs: add email client compatibility notes - #55

Merged
ivoIturrieta merged 1 commit into
unlayer:mainfrom
Shreyans-704:docs/email-client-compatibility
Aug 24, 2026
Merged

docs: add email client compatibility notes#55
ivoIturrieta merged 1 commit into
unlayer:mainfrom
Shreyans-704:docs/email-client-compatibility

Conversation

@Shreyans-704

Copy link
Copy Markdown
Contributor

Summary

Adds email client compatibility documentation requested in #23.

Changes

  • Documents the primary target clients: Outlook, Gmail, Yahoo, and Apple Mail.
  • Explains why email mode uses table-based HTML and Outlook/MSO-specific patterns.
  • Documents repository-scoped compatibility caveats and clarifies that automated validation is not an inbox-client emulator matrix.
  • Documents the CSP safety probe and its strict-CSP interpretation.
  • Links the compatibility notes to the relevant snapshot, golden-template, browser E2E, and CSP validation files.
  • Preserves the existing Litmus and Email on Acid validation information.

Validation

  • pnpm test — 450 tests passed.
  • git diff --check — clean.
  • pnpm test:csp — currently fails because of a React CommonJS/ESM interop issue (createContext named export), not because of a CSP code-generation failure.
  • No source code, tests, dependencies, or generated snapshots were changed.

Closes #23

Copilot AI lite review requested due to automatic review settings August 15, 2026 19:17

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “Email Client Compatibility Notes” section to the root README to make Elements’ email-client targeting, rationale (table/MSO patterns), validation scope, and CSP gate expectations explicit for evaluators—aligning with the documentation request in #23.

Changes:

  • Documented the primary targeted email clients (Outlook, Gmail, Yahoo, Apple Mail).
  • Explained why <Email> renders table-based / MSO-specific markup and linked to repo evidence and validation tests.
  • Documented the strict CSP probe intent and how to interpret test:csp results.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@codecov

codecov Bot commented Aug 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.50%. Comparing base (63d7289) to head (2810146).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #55   +/-   ##
=======================================
  Coverage   95.50%   95.50%           
=======================================
  Files          31       31           
  Lines        1937     1937           
  Branches      382      382           
=======================================
  Hits         1850     1850           
  Misses         86       86           
  Partials        1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Shreyans-704

Shreyans-704 commented Aug 24, 2026

Copy link
Copy Markdown
Contributor Author

@ericdellacasa8
The Storybook PR preview check is currently failing at the deployment step with a 403:

Permission to unlayer/elements.git denied to github-actions[bot]

The build itself completes successfully; the failure occurs when peaceiris/actions-gh-pages@v3 attempts to push the PR preview to the gh-pages branch. Since this appears to be a workflow permission issue rather than a problem with the documentation changes, I haven't modified the workflow.

@ivoIturrieta
ivoIturrieta merged commit 9aaa145 into unlayer:main Aug 24, 2026
3 of 4 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.

Docs: Add Email Client Compatibility Notes

3 participants