iDO Documentation

December 21, 2025 · View on GitHub

Welcome to iDO! This is a local-first AI desktop copilot that helps you track activities, summarize context, and get task recommendations.

👥 User Guide

For users who want to use iDO

Download & Installation - Download and install iDO
Features - Learn about iDO's capabilities
FAQ - Frequently asked questions
Troubleshooting - Common issues and solutions

💻 Developer Documentation

For developers who want to compile, develop, or contribute

Development Setup - Set up development environment
Development Workflow - Common development tasks
Architecture - System design and data flow
Frontend Guide - React, TypeScript, Tailwind
Backend Guide - Python, PyTauri, FastAPI

🚀 Quick Start

I'm a User

If you just want to use iDO without compiling or developing:

I'm a Developer

If you want to compile, develop, or contribute code:

I want to...

...download and install iDO → User Guide: Installation

...understand what iDO can do → Features Overview

...fix a problem → FAQ or Troubleshooting

...set up a development environment → Developer: Installation

...understand how iDO works → Architecture Overview

...add a new feature → Development Workflow

...create an API endpoint → Development Workflow

...modify the database → Development Workflow

📖 Documentation Structure

docs/
├── user-guide/              # 👥 User Documentation
│   ├── installation.md      # Download and install
│   ├── features.md          # Feature overview
│   ├── faq.md              # Common questions
│   └── troubleshooting.md  # Problem solving
│
└── developers/             # 💻 Developer Documentation
    ├── getting-started/    # Getting started
    │   ├── installation.md
    │   ├── first-run.md
    │   └── development-workflow.md
    │
    ├── architecture/       # System architecture
    │   ├── README.md
    │   ├── three-layer-design.md
    │   ├── data-flow.md
    │   └── tech-stack.md
    │
    ├── guides/            # Development guides
    │   ├── frontend/      # Frontend development
    │   ├── backend/       # Backend development
    │   └── features/      # Feature implementation
    │
    └── deployment/        # Build and deployment
        └── troubleshooting.md

🤝 Contributing

Welcome to contribute! Please check:

Development Setup
Development Workflow
CLAUDE.md - Project rules and best practices

💬 Get Help

🐛 Report Issues: GitHub Issues
💡 Feature Requests: GitHub Issues
💬 Discussions: GitHub Discussions

Navigation: ← Back to Project Root