Skip to content

chore(docs): add comprehensive editor package documentation#3097

Closed
joaopcm wants to merge 3 commits intojoaopcm/editor-examples-appfrom
joaopcm/editor-docs
Closed

chore(docs): add comprehensive editor package documentation#3097
joaopcm wants to merge 3 commits intojoaopcm/editor-examples-appfrom
joaopcm/editor-docs

Conversation

@joaopcm
Copy link
Member

@joaopcm joaopcm commented Mar 20, 2026

Summary

  • Adds 16 Mintlify documentation pages for the @react-email/editor package organized into 4 sections: Overview & Getting Started, Features (7 pages), Advanced (3 pages), and API Reference (4 pages)
  • Creates 2 reusable MDX snippets for install instructions and next-steps navigation
  • Pages are hidden from the sidebar (not added to docs.json navigation) but accessible via direct URL for review
  • All code examples are sourced from PR feat(editor): redesign examples app and fix bubble menu bugs #3094's revamped examples app

Pages created

Section Pages
Overview Overview, Getting Started
Features Bubble Menu, Slash Commands, Link Editing, Buttons, Column Layouts, Theming, Email Export
Advanced Extensions, Custom Extensions, Event Bus
API Reference useEditor, Extensions List, UI Components, Theming API

Test plan

  • Run cd apps/docs && npx mintlify dev
  • Visit each page via direct URL (e.g., /editor/overview, /editor/getting-started)
  • Verify pages do NOT appear in the sidebar navigation
  • Check all internal links between pages work
  • Verify code examples render correctly in code blocks
  • Confirm reusable snippets (install, next-steps) render on pages that import them

🤖 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.

  • New Features
    • 16 pages across Overview & Getting Started, Features (Bubble Menu, Slash Commands, Link Editing, Buttons, Columns, Theming, Export), Advanced (Extensions, Custom Extensions, Event Bus), and API (useEditor, UI Components, Extensions List, Theming API)
    • Reusable MDX snippets for install and next steps; pages remain hidden from docs.json and are accessible via direct URLs (e.g., /editor/overview)
    • Expanded and clarified docs for theming (EmailTheming), UI components, export pipeline, and event bus; updated examples with clearer sample content and default behaviors
    • Consolidated CSS guidance to @react-email/editor/themes/default.css and updated all examples to use the bundled styles

Written for commit 70361cb. Summary will update on new commits.

- 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
@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2026

⚠️ No Changeset found

Latest commit: 70361cb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Contributor

vercel bot commented Mar 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
react-email Ready Ready Preview, Comment Mar 20, 2026 7:48pm
react-email-demo Ready Ready Preview, Comment Mar 20, 2026 7:48pm

Request Review

@joaopcm joaopcm self-assigned this Mar 20, 2026
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 content and a redeclared key, so copy‑pasted examples in apps/docs/editor/features/email-export.mdx, apps/docs/editor/advanced/custom-extensions.mdx, and apps/docs/editor/api-reference/theming-api.mdx won’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
@joaopcm joaopcm changed the title docs(editor): add comprehensive editor package documentation chore(docs): add comprehensive editor package documentation Mar 20, 2026
- Update extension, theming, UI, and export docs
- Clarify defaults and bundled styles
- Add clearer sample content for custom extensions and export
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.

1 participant