chore(docs): add editor guides and API references#3104
Open
chore(docs): add editor guides and API references#3104
Conversation
- Add dedicated API pages for EmailNode, EmailMark, composeReactEmail, and UI components - Reorganize editor docs navigation and rename the custom extensions guidance - Expand theming docs with serialization and theme behavior details
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
joaopcm
changed the title
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
1 issue found across 12 files
Confidence score: 4/5
- This PR is likely safe to merge with minimal risk, since the only reported issue is a documentation example problem rather than a runtime code regression.
- In
apps/docs/editor/api-reference/email-node.mdx, the snippet usesmergeAttributeswithout importing it, so readers copying the example may hit errors and lose confidence in the docs. - Pay close attention to
apps/docs/editor/api-reference/email-node.mdx- add the missingmergeAttributesimport so the example is runnable as written.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="apps/docs/editor/api-reference/email-node.mdx">
<violation number="1" location="apps/docs/editor/api-reference/email-node.mdx:33">
P2: The example calls `mergeAttributes` but never imports it, so the snippet is not runnable as written.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
- Drop the Editor anchor and all nested editor pages from apps/docs/docs.json - Keep Documentation as the sole top-level docs navigation entry
- Add compound component examples for BubbleMenu and ButtonBubbleMenu - Clarify toolbar, selector, and context usage
- Clarify image and link bubble menu subcomponents and context - Add LinkBubbleMenu form props and custom usage examples - Document slash command custom rendering and custom commands
- Document the export pipeline, theming, and template flow - Add SerializerPlugin reference and usage guidance - Clarify preview text and HTML/plain text output
Member
Author
|
Auto-merge enabled (squash) via PR Sentinel. |
- Drop `lucide-react` from the editor install snippet - Keep the package list aligned across npm, yarn, pnpm, and bun
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
1 participant
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
Editorsection to the docs navigation with new overview, getting started, feature, advanced, and API reference pages.EmailNode,EmailMark,composeReactEmail, extensions, theming, and the event bus.Testing
Summary by cubic
Adds editor guides, split API references, and expanded
composeReactEmaildocs; improves UI docs with composition examples and simplifies navigation by removing the “Editor” top-level section. Also dropslucide-reactfrom install snippets.New Features
composeReactEmail,EmailNode, andEmailMarkfrom@react-email/editor/core, covering the serialization pipeline, theming integration,SerializerPlugin, preview text, and HTML/plain text outputs.BubbleMenu,LinkBubbleMenu,ButtonBubbleMenu,ImageBubbleMenu, andSlashCommandfrom@react-email/editor/ui, adding compound composition examples, context hooks,LinkBubbleMenu.Formprops with validation callbacks, andSlashCommandcustom rendering and commands.Refactors
apps/docs/docs.json: removed the “Editor” anchor, kept “Documentation” as the sole top-level entry, and formatted for Biome..from()wrappers and linked to the new API pages; expanded theming docs with a “How theming works” section on the serialization pipeline and inline style injection.lucide-reactfrom the editor install snippet across npm/yarn/pnpm/bun to avoid an unnecessary dependency.Written for commit cc720ad. Summary will update on new commits.