Complete documentation for the CKEditor MJML Email Editor Chrome Extension with Drag-and-Drop Visual Builder.
- Quick Start Guide - Get started in 5 minutes
- Visual Builder Guide - Complete feature documentation
- Original Design - Original project vision
- Development Guide - Contributing and extending
- Architecture - System design and data flow
- Testing Guide - Comprehensive test plan
- Technical Specs - Technical implementation details
- Implementation Summary - What was built
- Drag-and-Drop Feature Spec - Original feature specification
- Changelog - Version history
File: quick-start-visual-builder.md
Audience: End users
Purpose: Get up and running quickly
Contents:
- 5-minute tutorial
- Common patterns
- Tips & tricks
- Example workflows
- Troubleshooting
File: visual-builder-guide.md
Audience: End users & power users
Purpose: Comprehensive feature reference
Contents:
- Feature overview
- Component library
- Property editing
- API reference
- Best practices
- Troubleshooting
File: DEVELOPMENT.md
Audience: Contributors & developers
Purpose: How to extend and contribute
Contents:
- Project structure
- Adding components
- Code style guide
- Git workflow
- Common issues
- Future enhancements
File: ARCHITECTURE.md
Audience: Developers & architects
Purpose: System design understanding
Contents:
- System diagrams
- Data flow charts
- Component relationships
- API surface
- Performance considerations
- Error handling
File: testing-guide.md
Audience: QA & developers
Purpose: Comprehensive test coverage
Contents:
- 15 test categories
- 45+ test cases
- Bug reporting template
- Success criteria
- Known limitations
File: tech.md
Audience: Technical team
Purpose: Technical implementation details
Contents:
- Technology stack
- API integrations
- Security considerations
- Performance benchmarks
File: drag-and-drop-feature.md
Audience: Product & engineering
Purpose: Feature requirements
Contents:
- Feature requirements
- Architecture changes
- Implementation plan
- Acceptance criteria
- Future enhancements
File: design.md
Audience: Product & design
Purpose: Original vision
Contents:
- Project goals
- User stories
- UI/UX considerations
- Feature roadmap
- Start with Quick Start Guide
- Reference Visual Builder Guide for details
- Check Troubleshooting if issues arise
- Read Development Guide - "Adding a New Component"
- Review Architecture - "Component System"
- Test using Testing Guide
- Start with Architecture
- Review Development Guide
- Read inline code comments in source files
- Read Development Guide
- Review Testing Guide
- Check Changelog for current status
- See Git workflow section
- Use template in Testing Guide
- Check Known Issues
- Include console errors and screenshots
| Category | Files | Lines | Topics |
|---|---|---|---|
| User Guides | 2 | ~700 | Quick start, Features |
| Developer Guides | 3 | ~1200 | Contributing, Architecture, Testing |
| Technical Specs | 2 | ~500 | Implementation, Feature spec |
| Project Docs | 2 | ~400 | Design, Summary |
| Total | 9 | ~2800 | All aspects |
- Visual Builder Guide - Component Library section
- Development Guide - Adding Components
- Architecture - Component Registry
- Source:
extension/mjmlComponents.js
- Quick Start - Usage
- Feature Spec - Requirements
- Architecture - Event Flow
- Source:
extension/mjmlVisualBuilder.js
- Visual Builder Guide - Data Structure
- Development Guide - Tree Operations
- Architecture - Tree Structure
- Source:
extension/mjmlTreeUtils.js
- Quick Start - Customize Appearance
- Visual Builder Guide - Property Editor
- Development Guide - Adding Property Types
- Source:
extension/mjmlVisualBuilder.js
- Quick Start - Workflow
- Visual Builder Guide - Template Storage
- Architecture - Storage Structure
- Source:
extension/mjmlEditor.js,extension/content.js
- Visual Builder Guide - Multi-Mode Editor
- Architecture - Mode Switching Flow
- Source:
extension/mjmlEditor.js
Issue: Can't find documentation
Solution: Use this index or search by topic above
Issue: Documentation outdated
Solution: Check Changelog for latest version
Issue: Missing information
Solution: Check inline code comments or file an issue
Issue: Conflicting information
Solution: Implementation Summary is most current
- Adding Features: Update relevant guides + architecture
- Bug Fixes: Update troubleshooting sections
- API Changes: Update API reference + examples
- Breaking Changes: Update migration guide
When making changes:
- Update relevant user guides
- Update developer documentation
- Update architecture diagrams if needed
- Add to changelog
- Update this index if adding files
- Review for accuracy
- Clear, concise language
- Active voice
- Examples for complex topics
- Code snippets with syntax highlighting
- Screenshots where helpful
- Headers for navigation
- Code blocks with language tags
- Tables for structured data
- Lists for step-by-step
- Links for cross-references
- Lowercase with hyphens
- Descriptive names
.mdextension- Group by topic
- Quick Start Guide
- Visual Builder Guide - Basic sections
- Try examples from guides
- Visual Builder Guide - Advanced sections
- Development Guide - Overview
- Architecture - Data Flow
- Development Guide - Complete
- Architecture - Complete
- Testing Guide
- Source code review
- Check documentation - Most questions answered here
- Search issues - Someone may have asked already
- File an issue - Use bug template
- Code comments - Inline documentation in source
- Complete Quick Start
- Build your first email template
- Save and share templates
- Review Architecture
- Set up development environment
- Run tests from Testing Guide
- Make your first contribution
All documentation current as of Version 0.2.0 (January 2, 2026)
See Changelog for version history.
Last Updated: January 2, 2026
Documentation Version: 0.2.0
Total Pages: 9 major documents
Status: ✅ Complete