docs: add email client compatibility notes - #55
Conversation
There was a problem hiding this comment.
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:cspresults.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
|
@ericdellacasa8
The build itself completes successfully; the failure occurs when |
Summary
Adds email client compatibility documentation requested in #23.
Changes
Validation
pnpm test— 450 tests passed.git diff --check— clean.pnpm test:csp— currently fails because of a React CommonJS/ESM interop issue (createContextnamed export), not because of a CSP code-generation failure.Closes #23