Open Assistant Documentation

Welcome to the Open Assistant documentation. This documentation covers architecture, setup, and integrations.

Quick Links

Getting Started

• Configuration Guide - Configure services and credentials
• Development Setup - Set up development environment
• Development Checklist - Pre-flight checks before deploying

Architecture

• Architecture Overview
• System Architecture - Deployment, containers, infrastructure
• Solution Architecture - Technology stack and frameworks
• Software Architecture - Application design and components
• Agent Architecture - Multi-agent system
• Database Schema - Database structure and tables
• Capabilities - Implemented and planned capabilities

Integrations (by Platform)

• Google Platform - Gmail and Google Calendar
• Google Ads - Google Ads campaign data
• Google News - News search
• Microsoft Platform - Outlook, OneDrive, and Outlook Calendar
• Google Navigator - Places, Directions, and Geocoding
• Notion - Note-taking and knowledge management
• Nextcloud - Self-hosted file storage
• Browser Automation - Web browsing with Playwright
• WhatsApp Messaging - WhatsApp integration (text, voice, images)
• Whisper Transcription - Voice message transcription via OpenAI Whisper
• Mistral OCR - PDF text extraction
• Brave Search - Web search
• Slack - Slack messaging
• Toggl - Time tracking
• LLM Providers - LLM configuration

Documentation Structure

docs/
├── README.md                              # This file
├── development-checklist.md                # Pre-flight checks before deploying
├── architecture/
│   ├── system-architecture.md             # Deployment and infrastructure
│   ├── solution-architecture.md           # Technology stack and frameworks
│   ├── software-architecture.md            # Application design and components
│   ├── agents.md                         # Multi-agent system
│   ├── database-schema.md                 # Database tables and relationships
│   └── capabilities.md                    # Implemented and planned capabilities
├── integrations/
│   ├── google.md                         # Google platform (Gmail, Calendar)
│   ├── google_ads.md                     # Google Ads campaign data
│   ├── google_news.md                    # Google News search
│   ├── microsoft.md                      # Microsoft platform (Outlook, OneDrive, Calendar)
│   ├── google_navigator.md               # Google Places, Directions, Geocoding
│   ├── notion.md                         # Notion integration
│   ├── nextcloud.md                      # Nextcloud file storage
│   ├── browser.md                        # Browser automation with Playwright
│   ├── whatsapp.md                       # WhatsApp messaging (text, voice, images)
│   ├── whisper.md                        # Voice message transcription (Whisper)
│   ├── mistral_ocr.md                    # Mistral OCR for PDF extraction
│   ├── brave.md                          # Brave Search integration
│   ├── slack.md                          # Slack messaging
│   ├── toggl.md                          # Toggl time tracking
│   └── llm-providers.md                  # LLM provider configuration
└── setup/
    ├── configuration.md                   # Configuration reference
    └── development.md                    # Development environment setup

Contributing to Documentation

🚨 IMPORTANT: This project follows documentation-first development.

Documentation-First Workflow

1. Before implementing ANY feature:
2. Document it in relevant docs/ files
3. Add diagrams (Mermaid)
4. Get user approval

5. THEN implement

6. When adding new features:

7. Update architecture docs
8. Add code examples
9. Update API reference if applicable
10. Add troubleshooting notes

11. Keep implementation in sync

12. Development Guidelines:

13. Read CONTRIBUTING.md - Contribution guidelines
14. Read Development Setup - Environment setup and workflow

Need Help?

For issues or questions: 1. Check the troubleshooting section in integration guides 2. Review the architecture documentation 3. Open an issue in the repository

Version Information

Documentation follows the project's tag-based versioning system. Each release tag corresponds to the state of documentation at that time.