MIRIX Documentation

Professional documentation website for MIRIX - a multi-agent personal assistant for intelligent screen activity tracking.

📖 View Documentation

Live Site: https://mirix-ai.github.io/MIRIX-docs/

🚀 Local Development

Prerequisites

• Python 3.11 or later
• Git

Setup

1. Clone the repository

   git clone https://github.com/Mirix-AI/MIRIX-docs.git
   cd MIRIX-docs

2. Install dependencies

   pip install -r requirements.txt

3. Serve locally

   mkdocs serve

4. Open in browser

   • Visit http://localhost:8000
   • Documentation will auto-reload when you make changes

Building

To build the static site:

mkdocs build

The built site will be in the site/ directory.

📁 Documentation Structure

docs/
├── index.md                    # Homepage
├── getting-started/
│   └── installation.md       # Installation and getting started guide
├── architecture/
│   ├── multi-agent-system.md # Multi-agent architecture
│   ├── memory-components.md   # Six memory types
│   └── search-capabilities.md # Advanced search
├── user-guide/
│   ├── desktop-app.md         # Desktop application (coming soon)
│   └── backend-usage.md       # Python backend usage
├── advanced/
│   ├── performance.md         # Performance optimization
│   ├── security-privacy.md    # Security and privacy
│   └── backup-restore.md      # Backup and restore
└── assets/                    # Images and media files

🛠 Technology Stack

• MkDocs - Static site generator
• Material for MkDocs - Beautiful documentation theme
• GitHub Pages - Hosting platform
• GitHub Actions - Automated deployment

📝 Contributing

Content Guidelines

1. Use clear, concise language
2. Include code examples for technical concepts
3. Add diagrams using Mermaid for complex architectures
4. Test all code examples before submitting
5. Follow the existing structure and formatting

Making Changes

1. Fork the repository
2. Create a feature branch

   git checkout -b improve-installation-docs

3. Make your changes
4. Test locally

   mkdocs serve

5. Submit a pull request

Writing Style

• Use bold for important terms and UI elements
• Use inline code for file names, commands, and code snippets
• Use admonitions (info, warning, tip) for important notes
• Include cross-references to related sections

🚀 Deployment

The documentation is automatically deployed using GitHub Actions:

1. Push to main branch triggers the deployment workflow
2. GitHub Actions builds the documentation using MkDocs
3. GitHub Pages serves the built site

Manual Deployment

If needed, you can deploy manually:

mkdocs gh-deploy

📋 Configuration

Key configuration files:

• mkdocs.yml - Main MkDocs configuration
• requirements.txt - Python dependencies
• .github/workflows/docs.yml - GitHub Actions workflow

Customization

To customize the documentation:

1. Theme settings - Edit mkdocs.yml under theme:
2. Navigation - Update the nav: section in mkdocs.yml
3. Extensions - Add Markdown extensions in markdown_extensions:
4. Styling - Add custom CSS in docs/assets/

🔧 Troubleshooting

Common Issues

MkDocs command not found

pip install mkdocs mkdocs-material

Build errors

mkdocs build --strict --verbose

Broken links

mkdocs serve --strict

Getting Help

• Documentation Issues: Open an issue
• MIRIX Project: Main repository
• Contact: [email protected]

📄 License

This documentation is licensed under the same terms as the MIRIX project - see the MIT License.

---

View Live Documentation →