# AxonHub Documentation Index

Welcome to the AxonHub documentation center! This index will help you quickly find the guides and reference materials you need.

## 📚 Documentation Navigation

### 🚀 Getting Started

| Document | Description |
|----------|-------------|
| [Quick Start Guide](getting-started/quick-start.md) | Get AxonHub up and running in minutes |
| [Request Processing](getting-started/request-processing.md) | Understand how AxonHub processes API requests |

### 📖 User Guides

| Document | Description |
|----------|-------------|
| [Channel Management](guides/channel-management.md) | Configure and manage AI provider channels |
| [Model Management](guides/model-management.md) | Model mapping, associations, and priority configuration |
| [API Key Profiles](guides/api-key-profiles.md) | Create and manage API key profiles |
| [Permissions](guides/permissions.md) | Enterprise RBAC access control configuration |
| [Load Balancing](guides/load-balance.md) | Smart routing and failover settings |
| [Cost Tracking](guides/cost-tracking.md) | Real-time monitoring and usage analytics |
| [Request Tracing](guides/tracing.md) | Complete request traceability |
| [Request Override](guides/request-override.md) | Dynamically modify request parameters |
| [Prompt Protection Rules](guides/prompt-protection-rules.md) | Sensitive information filtering and protection |
| [Antigravity](guides/antigravity.md) | Advanced routing and optimization features |

### 🤖 AI Coding Tools Integration

| Document | Description |
|----------|-------------|
| [Claude Code Integration](guides/claude-code-integration.md) | Configure Claude Code to use AxonHub |
| [Codex Integration](guides/codex-integration.md) | Configure Codex to use AxonHub |
| [OpenCode Integration](guides/opencode-integration.md) | Configure OpenCode to use AxonHub |

### 🔌 API Reference

| Document | Description |
|----------|-------------|
| [OpenAI API](api-reference/openai-api.md) | OpenAI-compatible API interface documentation |
| [Anthropic API](api-reference/anthropic-api.md) | Anthropic-compatible API interface documentation |
| [Gemini API](api-reference/gemini-api.md) | Gemini-compatible API interface documentation |
| [Image Generation API](api-reference/image-generation.md) | Image generation interface documentation |
| [Embedding API](api-reference/embedding-api.md) | Vector embedding interface documentation |
| [Rerank API](api-reference/rerank-api.md) | Reranking interface documentation |

### 🚀 Deployment Guides

| Document | Description |
|----------|-------------|
| [Docker Deployment](deployment/docker.md) | Deploy using Docker and Docker Compose |
| [Configuration](deployment/configuration.md) | Detailed configuration options |

### 🛠️ Development

| Document | Description |
|----------|-------------|
| [Development Guide](development/development.md) | Local development setup and contribution guidelines |
| [Git Workflow](development/git-workflow.md) | Git branching and commit conventions |
| [Entity Relationship Diagram](development/erd.md) | Database model relationship diagrams |
| [Transformation Flow](development/transformation-flow.md) | Request/response transformation process |
| [Authz Coding Guidelines](development/authz-coding-guidelines.md) | Guidelines for writing authorization code |

### ❓ FAQ

| Document | Description |
|----------|-------------|
| [FAQ](faq/faq.md) | Frequently asked questions |

---

## 🔗 Related Links

- [GitHub Repository](https://github.com/looplj/axonhub)
- [DeepWiki Documentation](https://deepwiki.com/looplj/axonhub)
- [Zread AI](https://zread.ai/looplj/axonhub)

## 🌐 Multilingual Documentation

- [中文文档](../zh/index.md)

---

> 💡 **Tip**: If you're new to AxonHub, we recommend starting with the [Quick Start Guide](getting-started/quick-start.md), then reading [Channel Management](guides/channel-management.md) and [Model Management](guides/model-management.md) to understand the core features.