# OpenAkita Documentation

Welcome to the OpenAkita documentation.

## Quick Links

| Document | Description |
|----------|-------------|
| [Getting Started](getting-started.md) | Installation and first steps |
| [Architecture](architecture.md) | System design and components |
| [Configuration](configuration.md) | All configuration options |

## Setup Tutorials

| Tutorial | Description |
|----------|-------------|
| ⭐ [LLM Provider Setup](llm-provider-setup-tutorial.md) | API Key registration, endpoint config, multi-endpoint Failover for all major providers |
| ⭐ [IM Channel Setup](im-channel-setup-tutorial.md) | Step-by-step tutorial for Telegram, Feishu, DingTalk, WeCom, QQ Official Bot, OneBot |
| [Configuration Guide](configuration-guide.md) | Desktop app quick setup & full setup walkthrough |

## Guides

| Guide | Description |
|-------|-------------|
| [Skills System](skills.md) | Creating and using skills |
| [IM Channels Reference](im-channels.md) | IM channels technical reference (media matrix, architecture) |
| [MCP Integration](mcp-integration.md) | Connect external services |
| [Persona & Liveness](persona-and-liveness.md) | Persona system and proactive engine |
| [Testing](testing.md) | Test framework and coverage |

## Additional Resources

| Resource | Location |
|----------|----------|
| [Deployment Guide](deploy.md) | Production deployment |
| [Contributing](../CONTRIBUTING.md) | How to contribute |
| [Changelog](../CHANGELOG.md) | Version history |
| [Security](../SECURITY.md) | Security policy |

## Documentation Structure

```
docs/
├── README.md                        # This file
├── getting-started.md               # Quick start guide
├── architecture.md                  # System architecture
├── configuration.md                 # Configuration reference
├── configuration-guide.md           # Desktop app setup walkthrough
├── llm-provider-setup-tutorial.md   # ⭐ LLM provider setup tutorial
├── im-channel-setup-tutorial.md     # ⭐ IM channel setup tutorial
├── im-channels.md                   # IM channels technical reference
├── skills.md                        # Skills system guide
├── mcp-integration.md               # MCP guide
├── deploy.md                        # Deployment guide
├── testing.md                       # Testing guide
└── assets/                          # Images and diagrams
    └── logo.png
```

## Contributing to Docs

Found an error or want to improve the documentation?

1. Fork the repository
2. Edit the relevant markdown files
3. Submit a pull request

See [CONTRIBUTING.md](../CONTRIBUTING.md) for details.
