Repository navigation
docs: describe Elements by the tasks developers ask for - #59
Merged
Merged
Conversation
Agents are asked "how do I generate an invoice in React?" or "I need transactional email templates for my Next.js SaaS", not for a library that renders three modes. Lead every description with those tasks while keeping the "Write once in React" tagline. - npm description and README (shown on npm): transactional emails, email templates, landing pages, invoices, reports, documents and PDFs - npm keywords: add transactional-email, invoice, pdf, landing-page, nextjs - repo README intro: same wording above the three output modes - context7.json description: same wording (within the 200-char limit)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=======================================
Coverage 95.54% 95.54%
=======================================
Files 32 32
Lines 1975 1975
Branches 390 390
=======================================
Hits 1887 1887
Misses 87 87
Partials 1 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Agents aren't asked "give me a library that renders three modes." They're asked "how do I generate an invoice in React?" or "I need transactional email templates for my Next.js SaaS." This PR leads Elements' descriptions with those tasks. The "Write once in React…" tagline stays as the human-facing headline.
description(packages/react/package.json)keywordstransactional-email,invoice,pdf,landing-page,nextjspackages/react/README.md(the npm page)README.mdintrocontext7.jsondescription"Print-ready HTML for PDF" stays accurate: Elements renders HTML that a PDF tool turns into a file.
Notes
@unlayer/react-elementsrelease./unlayer/elementsin Context7.main. This PR doesn't reformat them, to keep the diff focused.Testing
package.jsonis valid JSON.context7.jsonvalidates against Context7's schema.📖 Storybook Preview: https://unlayer.github.io/elements/pr/59/