This documentation package contains complete architecture, technical decisions, and development guidelines for building a modern, modular rich text editor.

1. 00-PROJECT-OVERVIEW.md - Vision, goals, and project scope
2. 01-TECH-STACK.md - All technology decisions with rationale
3. 02-ARCHITECTURE.md - Domain-Driven Design model and system architecture
4. 03-MONOREPO-STRUCTURE.md - Package organization and structure

5. 04-TESTING-STRATEGY.md - TDD approach and test levels
6. 05-CI-CD.md - Continuous Integration and Deployment pipelines
7. 06-GITHUB-WORKFLOW.md - Agile process and issue management
8. 07-DEVELOPMENT-GUIDE.md - Day-to-day development practices

9. 08-TODO-FUTURE.md - Deferred decisions and future features

1. Read 00-PROJECT-OVERVIEW.md for vision
2. Review 02-ARCHITECTURE.md for domain model
3. Check 07-DEVELOPMENT-GUIDE.md for workflow

• ✅ Domain-Driven Design - Respect bounded contexts
• ✅ Test-Driven Development - Write tests first
• ✅ Monorepo Structure - Keep packages independent
• ✅ Type Safety - TypeScript strict mode
• ✅ Documentation - Code is self-documenting

• Language: TypeScript (strict)
• Package Manager: pnpm
• Monorepo: Nx
• Build: @nx/rollup
• Testing: Vitest + Playwright
• Core Engine: ProseMirror

1. Document Domain - Content structure and validation
2. Editor Domain - Editor engine and state
3. Extension Domain - Plugin system
4. Serialization Domain - Format conversion

packages/
├── core/              # @helix/core
├── extensions/        # @helix/extension-*
│   ├── bold/
│   ├── italic/
│   └── ...
├── react/            # @helix/react
├── vue/              # @helix/vue
└── vanilla/          # @helix/vanilla

1. RED - Write failing test
2. GREEN - Minimal implementation
3. REFACTOR - Improve code

1. Pick issue from "Ready" column
2. Create feature branch
3. Follow TDD process
4. Create Pull Request
5. Code review
6. Merge to develop

→ Read 00-03 (Overview, Tech Stack, Architecture, Structure)

→ Read 04-07 (Testing, CI/CD, GitHub Workflow, Development Guide)

→ Read 08 (TODO & Future)

This documentation is a living guide:

• Update when making architectural decisions
• Document new patterns as they emerge
• Add to TODO when deferring decisions
• Review quarterly for accuracy

• "Domain-Driven Design" by Eric Evans
• "Implementing Domain-Driven Design" by Vaughn Vernon

• "Test Driven Development: By Example" by Kent Beck
• "Growing Object-Oriented Software, Guided by Tests" by Freeman & Pryce

• ProseMirror Guide
• ProseMirror Examples

• Nx Documentation
• Monorepo.tools

When adding to this documentation:

1. Keep it concise and actionable
2. Provide examples where helpful
3. Explain why, not just what
4. Update the README if adding new files

Helix follows an open-core model:

The following packages are freely available under MIT License:

• Core packages (@helix/core)
• Basic extensions (@helix/extension-bold, @helix/extension-italic, etc.)
• Framework bindings (@helix/react, @helix/vue, @helix/vanilla)
• Self-hosted collaboration backend

Premium extensions and cloud services require a commercial license:

• AI extensions (@helix/extension-ai)
• Advanced collaboration features
• Helix Cloud (managed hosting)

See individual package LICENSE files for specific terms.

For v0.1 - v1.0: Everything is MIT licensed and free.

Version: 1.0.0 Last Updated: November 2025 Maintained By: Project Team

For questions or clarifications, please create a GitHub issue.