# Docs - 文档目录

本目录包含项目的详细文档。

## 📚 文档列表

### Nezha Agent 管理

- **[nezha_update_secret_README.md](nezha_update_secret_README.md)** - Nezha Agent Client Secret 更新工具完整文档
  - 详细的使用方法和参数说明
  - 安全性和可靠性特性
  - 错误处理和故障排查
  - 最佳实践建议

- **[QUICKSTART_nezha.md](QUICKSTART_nezha.md)** - Nezha Agent 5分钟快速开始
  - 快速上手步骤
  - 常见使用场景
  - 故障排查指南

### XXXigCC 管理

- **[xxxigcc_update_pool_url_README.md](xxxigcc_update_pool_url_README.md)** - XXXigCC Pool URL 更新工具完整文档
  - 详细的使用方法和参数说明
  - 条件更新和安全特性
  - 配置备份和服务管理
  - 故障排查和最佳实践

## 🔍 查找文档

### 按需求查找

| 我想... | 查看文档 |
|---------|----------|
| 快速更新 Nezha Agent | [快速开始](QUICKSTART_nezha.md) |
| 了解所有功能和参数 | [完整文档](nezha_update_secret_README.md) |
| 更新 XXXigCC Pool URL | [Pool URL 更新文档](xxxigcc_update_pool_url_README.md) |
| 查看配置示例 | [examples/](../examples/) |
| 了解项目架构 | [llmdoc/architecture/](../llmdoc/architecture/) |
| 学习最佳实践 | [llmdoc/guides/](../llmdoc/guides/) |

## 📖 文档组织

本项目采用分层文档结构:

```
docs/                    # 用户文档（人类友好）
├── nezha_update_secret_README.md
├── QUICKSTART_nezha.md
└── xxxigcc_update_pool_url_README.md

llmdoc/                  # LLM 文档系统（AI 友好）
├── index.md            # 文档索引
├── overview/           # 项目概览
├── guides/             # 操作指南
├── architecture/       # 架构文档
└── reference/          # 参考文档
```

### docs/ vs llmdoc/

- **docs/** - 面向人类用户的详细文档
  - 更注重实用性和可读性
  - 包含大量示例和使用场景
  - 适合快速上手和日常使用

- **llmdoc/** - 面向 LLM 的结构化文档
  - 更注重系统性和完整性
  - 按架构/指南/参考分类
  - 适合深入理解和检索

## 🚀 快速导航

### 新手入门

1. 阅读 [项目 README](../README.md)
2. 查看 [快速开始指南](QUICKSTART_nezha.md)
3. 参考 [示例配置](../examples/)

### 深入学习

1. 浏览 [LLM 文档索引](../llmdoc/index.md)
2. 学习 [Ansible 最佳实践](../llmdoc/guides/ansible-best-practices.md)
3. 了解 [项目架构](../llmdoc/architecture/)

### 问题解决

1. 查看文档中的"故障排查"章节
2. 检查 [示例配置](../examples/)是否正确
3. 参考 [安全最佳实践](../llmdoc/guides/security-best-practices.md)

## 🔄 文档更新

文档会随项目更新而更新。如发现文档问题:

- 提交 Issue 报告文档错误
- 直接提 PR 修正文档

## 📝 文档编写规范

如果您想贡献文档:

1. 遵循 Markdown 语法
2. 使用清晰的标题层级
3. 添加必要的代码示例
4. 包含实际使用场景
5. 保持简洁明了

## 🔗 相关资源

- [Ansible 官方文档](https://docs.ansible.com/)
- [YAML 语法指南](https://yaml.org/spec/1.2/spec.html)
- [Jinja2 模板文档](https://jinja.palletsprojects.com/)

---

有任何文档相关的问题？请提交 [Issue](../../issues)。