chore(docs): add comprehensive editor package documentation#3098
Open
chore(docs): add comprehensive editor package documentation#3098
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
- 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
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
joaopcm
changed the title
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
4 tasks
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
@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)Supersedes #3097 (which targeted
joaopcm/editor-examples-app).🤖 Generated with Claude Code
Summary by cubic
Adds comprehensive docs for
@react-email/editor, covering setup, features, advanced topics, and API reference. Pages are hidden from the sidebar for review and accessible via direct URLs.useEditor, UI components, theming API, and extensions list; advanced docs for extensions, custom extensions, and the event bus.@react-email/editor/themes/default.cssimport.docs.jsonnavigation (hidden) but can be visited directly.Written for commit 7b9edb7. Summary will update on new commits.