Skip to content

Add FAQ section to README#43

Merged
ivoIturrieta merged 2 commits into
mainfrom
readme-faq
Jul 9, 2026
Merged

Add FAQ section to README#43
ivoIturrieta merged 2 commits into
mainfrom
readme-faq

Conversation

@adeelraza

@adeelraza adeelraza commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds an FAQ section at the bottom of the root README (between Development and Contributing) answering the questions evaluators — human and LLM — most commonly raise about the project:

  • What makes Elements production ready? — the battle-tested rendering engine behind the Unlayer editor, pinned per release, with output locked by test gates
  • How is the email output actually tested? — the CI gates (golden template, snapshots, browser E2E with negative control, visual-drift baseline, Next.js integration) plus Litmus / Email on Acid testing across major clients
  • Is the PDF output a real PDF engine? — the two paths: Unlayer's PDF export service or any HTML-to-PDF library
  • Can I use Elements without the Unlayer platform? — MIT license, no network calls, no API key, output you own; platform integrations are opt-in
  • Is there a visual editor for Elements? — the Unlayer editor via renderToJson() design JSON and shared Custom Tools
  • Can I create custom components?registerElementsTool(), linked to the Custom Tools docs

Motivation

Feedback from LLMs evaluating the repo surfaced recurring hesitations (package maturity, unverified email-client claims, PDF being HTML-based, ecosystem lock-in). This section answers each directly in the README — the document those evaluations are built from — with claims verified against the repo (test gate scripts, exports, docs links).

🤖 Generated with Claude Code


📖 Storybook Preview: https://unlayer.github.io/elements/pr/43/

Answers the questions evaluators (human and LLM) commonly raise:
production readiness, email output testing, PDF generation paths,
platform independence, visual editor availability, and custom
components.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.50%. Comparing base (7c79aa3) to head (5f62afe).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #43   +/-   ##
=======================================
  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.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ivoIturrieta ivoIturrieta merged commit 743b375 into main Jul 9, 2026
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.

2 participants