# nnet 知识库

本目录包含 nnet 网络库的完整文档，按类别组织。

## 文档结构

### 📐 设计文档 (design/)
- [ARCHITECTURE.md](design/ARCHITECTURE.md) - 架构设计文档
- [DESIGN.md](design/DESIGN.md) - 完整设计方案

### 📋 需求文档 (requirements/)
- [REQUIREMENTS.md](requirements/REQUIREMENTS.md) - 需求文档

### 💻 开发文档 (development/)
- [CODE_STRUCTURE.md](development/CODE_STRUCTURE.md) - 代码结构说明
- [IMPLEMENTATION.md](development/IMPLEMENTATION.md) - 实现总结

### 🧪 测试文档 (testing/)
- [TEST_COVERAGE.md](testing/TEST_COVERAGE.md) - 测试覆盖率文档

### 📊 状态文档 (status/)
- [PROJECT_STATUS.md](status/PROJECT_STATUS.md) - 项目状态文档（推荐阅读）

### 📖 用户指南 (user-guide/)
- [PROTOCOL_FRAME_EXPLANATION.md](user-guide/PROTOCOL_FRAME_EXPLANATION.md) - 协议帧头字段概念详解
- [ROUTER_EXAMPLES.md](user-guide/ROUTER_EXAMPLES.md) - 路由系统详尽示例
- [CLIENT_POOL.md](user-guide/CLIENT_POOL.md) - 客户端连接池使用指南
- [MULTI_REPO_SETUP.md](user-guide/MULTI_REPO_SETUP.md) - 多仓库发布指南
- [DOMAIN_SETUP.md](user-guide/DOMAIN_SETUP.md) - 域名配置指南（已弃用）

### 🔧 实现细节 (implementation-details/)
实现细节文档，包含开发过程中的详细设计文档：
- API设计
- 架构重新设计
- 自动解析设计
- 数据流分析
- 优化总结
- 等等

## 快速开始

### 新用户
1. 阅读 [用户指南](user-guide/) 了解如何使用 nnet
2. 查看 [路由系统示例](user-guide/ROUTER_EXAMPLES.md)
3. 查看 [协议帧头说明](user-guide/PROTOCOL_FRAME_EXPLANATION.md)

### 开发者
1. 阅读 [架构设计](design/ARCHITECTURE.md) 了解整体架构
2. 查看 [代码结构](development/CODE_STRUCTURE.md) 了解代码组织
3. 查看 [项目状态](status/PROJECT_STATUS.md) 了解当前进度

### 贡献者
1. 阅读 [需求文档](requirements/REQUIREMENTS.md) 了解功能需求
2. 查看 [测试文档](testing/TEST_COVERAGE.md) 了解测试要求
3. 查看 [实现细节](implementation-details/) 了解实现细节

## 文档更新

文档会随着项目发展持续更新。如有问题或建议，请提交 Issue 或 Pull Request。

---

**最后更新**: 2024