chore(docs): add comprehensive editor package documentation#3097
chore(docs): add comprehensive editor package documentation#3097joaopcm wants to merge 3 commits intojoaopcm/editor-examples-appfrom
Conversation
- Add advanced, feature, and API reference docs for the editor - Document custom extensions, theming, events, and UI components - Add getting started and next-step snippets
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
6 issues found across 18 files
Confidence score: 4/5
- Overall risk looks low because the issues are documentation/example accuracy problems rather than runtime code changes.
- Most impactful: multiple code snippets reference undefined
contentand a redeclaredkey, so copy‑pasted examples inapps/docs/editor/features/email-export.mdx,apps/docs/editor/advanced/custom-extensions.mdx, andapps/docs/editor/api-reference/theming-api.mdxwon’t compile as written. - A few API docs list incorrect options/defaults (e.g.,
Table.resizable,Placeholder.includeChildren,SlashCommand.Root.items), which can mislead users but doesn’t affect shipped behavior. - Pay close attention to
apps/docs/editor/features/email-export.mdx,apps/docs/editor/advanced/custom-extensions.mdx,apps/docs/editor/api-reference/theming-api.mdx,apps/docs/editor/api-reference/extensions-list.mdx,apps/docs/editor/api-reference/ui-components.mdx- documentation examples and defaults are inconsistent with actual API behavior.
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/advanced/custom-extensions.mdx">
<violation number="1" location="apps/docs/editor/advanced/custom-extensions.mdx:201">
P2: The "Complete example" uses `content={content}` without defining `content`, so the snippet is not actually runnable as documented.</violation>
</file>
<file name="apps/docs/editor/api-reference/extensions-list.mdx">
<violation number="1" location="apps/docs/editor/api-reference/extensions-list.mdx:184">
P2: `Table.resizable` is documented as a configurable option, but this extension only supports `HTMLAttributes`, so this API entry is incorrect.</violation>
<violation number="2" location="apps/docs/editor/api-reference/extensions-list.mdx:342">
P2: The documented default for `Placeholder.includeChildren` is incorrect; the extension defaults it to `true`, not `false`.</violation>
</file>
<file name="apps/docs/editor/features/email-export.mdx">
<violation number="1" location="apps/docs/editor/features/email-export.mdx:49">
P2: The Quick start code sample uses `content` without defining it, so the example won’t compile when copied.</violation>
</file>
<file name="apps/docs/editor/api-reference/theming-api.mdx">
<violation number="1" location="apps/docs/editor/api-reference/theming-api.mdx:177">
P3: The example redeclares `const key` in the same scope, which is invalid TS/JS. Use a different variable name (or `let`) for the second call.</violation>
</file>
<file name="apps/docs/editor/api-reference/ui-components.mdx">
<violation number="1" location="apps/docs/editor/api-reference/ui-components.mdx:194">
P2: `SlashCommand.Root.items` is documented with the wrong default value; it defaults to `defaultSlashCommands`, not `[]`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
- Replace per-component style imports with the default theme in examples - Document the bundled CSS shortcut in getting started
- Update extension, theming, UI, and export docs - Clarify defaults and bundled styles - Add clearer sample content for custom extensions and export
Summary
@react-email/editorpackage organized into 4 sections: Overview & Getting Started, Features (7 pages), Advanced (3 pages), and API Reference (4 pages)docs.jsonnavigation) but accessible via direct URL for reviewPages created
Test plan
cd apps/docs && npx mintlify dev/editor/overview,/editor/getting-started)🤖 Generated with Claude Code
Summary by cubic
Adds a full docs set for
@react-email/editor(16 Mintlify pages) with refreshed examples, clarified defaults, and consolidated CSS guidance. Examples now import the bundled theme@react-email/editor/themes/default.css, and Getting Started shows the one-line CSS shortcut.docs.jsonand are accessible via direct URLs (e.g.,/editor/overview)EmailTheming), UI components, export pipeline, and event bus; updated examples with clearer sample content and default behaviors@react-email/editor/themes/default.cssand updated all examples to use the bundled stylesWritten for commit 70361cb. Summary will update on new commits.