Welcome to the Code Mavi IDE documentation! This comprehensive guide covers everything you need to know about Code Mavi IDE, the open-source, agent-first IDE.
Note: This documentation hub consolidates all project documentation including wiki content. For a quick overview, see Home.
- Quick Start Guide - Installation and first steps
- User Guide - Complete user documentation
- FAQ - Frequently asked questions
- Architecture Overview - System design and components
- Agent System - Triple agent architecture
- Lessons Learned - Analysis of Void and Cursor
- Roadmap - Development phases and timeline
- Custom Rules Guide - Creating project-specific rules
- Auto Dev Mode Tutorial - Automated project completion
- Provider Configuration - LLM provider setup
- Troubleshooting - Common issues and solutions
- Contributing Guide - How to contribute to Code Mavi IDE
- Quick Start for Developers - Development setup
- Implementation Guide - Detailed technical roadmap
- Project Plan - Strategic vision and architecture
- Plan Implementation - Phase-by-phase implementation
- Main Roadmap - High-level project timeline
- Codebase Guide - Understanding the codebase
- API Reference - Agent and tool APIs
- Performance Guide - Optimization techniques
- Security Guide - Security best practices
- Getting Started - First-time setup
- Architecture Overview - Understand the system
- Agent System - Learn about agents
- Contributing Guide - Start contributing
- Agent-First Architecture: Code Mavi IDE is built around intelligent agents
- Triple Agent System: Orchestrator, Executor, and Verifier work together
- Transparent Prompts: All system prompts are visible and editable
- Self-Correction: Agents automatically fix errors (max 3 retries)
- Checkpoint System: Safe rollback points before changes
All Code Mavi IDE documentation is:
- Complete: Covers all features and APIs
- Accurate: Regularly updated with the codebase
- Practical: Includes real-world examples
- Accessible: Written for different skill levels
- Documentation improvements welcome via PRs
- Examples from real users encouraged
- Translations for international community
- Regular updates based on feedback
- Documentation matches the latest release
- Breaking changes are clearly marked
- Migration guides for major updates
- Deprecation notices with alternatives
- Release Notes - Version history
- Roadmap - Future plans
- Contributor Updates - Development progress
- GitHub Issues: Bug reports and feature requests
- GitHub Discussions: Questions and discussions
- Discord Server: Real-time chat (link in main README)
- Documentation Issues: Report documentation problems
- Example Projects: Community-contributed examples
- Rule Templates: Shared
.mavi/rules.mdtemplates - Prompt Library: Community-optimized agent prompts
- Tool Extensions: User-created agent tools
- Read Getting Started
- Try basic tasks with the User Guide
- Explore Custom Rules
- Experiment with Auto Dev Mode
- Study Architecture Overview
- Review Contributing Guide
- Set up Development Environment
- Explore API Reference
- Understand Codebase Structure
- Review Roadmap
- Pick Good First Issues
- Join Community Channels
- Your First AI-Assisted Project
- Creating Effective Rules
- Using Semantic Search
- Safe Experimentation with Checkpoints
- Use clear, concise language
- Include code examples where helpful
- Link to related documentation
- Mark deprecated features clearly
- Include troubleshooting sections
- Headings: Use sentence case
- Code: Use TypeScript/JavaScript examples
- Images: Include alt text and captions
- Links: Use descriptive link text
- Notes: Use callouts for important information
Use your browser's find function (Cmd+F / Ctrl+F) to search within pages.
The documentation website includes full-text search across all pages.
Search the documentation repository on GitHub for specific topics.
- Fork the repository
- Create a documentation branch
- Make your changes
- Submit a pull request
- Fix typos and grammatical errors
- Add missing information
- Improve examples
- Translate to other languages
- Add new tutorials
All documentation changes are reviewed for:
- Accuracy and completeness
- Clarity and readability
- Code example correctness
- Link validity
This documentation is licensed under CC BY-SA 4.0.
- VS Code Team for the amazing foundation
- Void Editor Contributors for the initial fork
- Cursor Team for inspiration and innovation
- All Contributors who help improve Code Mavi IDE
Last updated: $(date)
Documentation version: $(git describe --tags)
For the latest updates, check the GitHub repository.