# Documentation Index

Welcome to the oh-my-kimi documentation! This page serves as a guide to all available documentation.

## 📚 Quick Links

| Document | Description | For |
|----------|-------------|-----|
| [README.md](../README.md) | Project overview and quick start | Everyone |
| [README.zh-CN.md](../README.zh-CN.md) | 中文项目概述 | 中文用户 |
| [Getting Started](GETTING-STARTED.md) | Installation and basic usage | New users |
| [Examples](EXAMPLES.md) | Real-world usage examples | Users |
| [Architecture](ARCHITECTURE.md) | Technical overview | Developers |
| [AGENTS.md](AGENTS.md) | Project guidance for AI | Contributors |

## 🎯 By Use Case

### I'm a New User

Start here:
1. [README.md](../README.md) - Understand what OMK is
2. [Getting Started](GETTING-STARTED.md) - Install and first steps
3. [Examples](EXAMPLES.md) - See how to use it

### I'm a Developer

Learn the internals:
1. [Architecture](ARCHITECTURE.md) - System design
2. [AGENTS.md](AGENTS.md) - Development guidelines
3. [Source code](../src/) - Implementation

### I Want to Contribute

Get involved:
1. [CONTRIBUTING.md](../CONTRIBUTING.md) - How to contribute
2. [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) - Community guidelines
3. [AGENTS.md](AGENTS.md) - Project guidance

### I Need Help

Find solutions:
1. [VERIFICATION.md](../VERIFICATION.md) - Troubleshooting
2. [GitHub Issues](https://github.com/Goblin1024/oh-my-kimi/issues) - Get help

## 📖 Document Details

### Getting Started

Learn the basics:
- Installation requirements
- Setup process
- Basic workflow commands
- Best practices

### Examples

Real-world scenarios:
- Building a todo app
- Fixing bugs
- Code refactoring
- API integration
- Writing documentation

### Architecture

Technical deep dive:
- System overview
- Component breakdown
- Data flow
- Hook protocol
- State management
- Security considerations

### AGENTS.md

For AI assistants working on OMK:
- Project structure
- Development guidelines
- Common tasks
- Testing strategy

## 🌍 Languages

Documentation is available in:
- **English** (primary)
- **简体中文** - [README.zh-CN.md](../README.zh-CN.md)

## 🔄 Updates

Documentation is versioned with the project. Check [CHANGELOG.md](../CHANGELOG.md) for documentation updates.

## 💡 Missing Something?

If you can't find what you're looking for:

1. Search the [GitHub Issues](https://github.com/Goblin1024/oh-my-kimi/issues)
2. Ask in [Discussions](https://github.com/Goblin1024/oh-my-kimi/discussions) (if enabled)
3. Open a new issue with the `documentation` label

---

Last updated: 2026-04-16