# NanoPencil 文档中心

本文档目录包含 NanoPencil AI 编码代理的所有项目文档。

## 📚 文档目录

### 快速开始

- **[结构.md](结构.md)** - 项目架构概述
  - 构建和运行命令
  - 核心抽象概念
  - 三种运行模式
  - 关键子系统说明
  - 配置路径说明

### 迁移指南

- **[单体仓库迁移指南.md](单体仓库迁移指南.md)** - Monorepo 迁移指南
  - 从单包到 pnpm workspace 的迁移过程
  - 包结构说明
  - 开发工作流程

- **[迁移总结.md](迁移总结.md)** - 迁移总结
  - 迁移过程中的关键变更
  - 向后兼容性说明

- **[单体仓库自述.md](单体仓库自述.md)** - Monorepo README
  - Monorepo 结构说明
  - 包管理命令

### 开发指南

- **[发布指南.md](发布指南.md)** - 发布指南
  - 版本发布流程
  - Changeset 使用方法
  - 发布检查清单

- **[工具管理器优化.md](工具管理器优化.md)** - 工具管理器优化
  - 性能优化说明
  - 缓存机制实现
  - 测试方法

### 变更日志

- **[变更日志.md](变更日志.md)** - 项目变更日志
  - 版本历史记录
  - 重要功能变更

- **[变更总结.md](变更总结.md)** - 变更总结
  - 近期改动概述

### MCP (Model Context Protocol) 集成

- **[MCP集成指南.md](MCP集成指南.md)** - MCP 集成完整指南
  - MCP 服务器配置
  - 工具使用说明
  - 故障排除

- **[MCP快速参考.md](MCP快速参考.md)** - MCP 快速参考
  - 常用命令速查
  - 配置示例

- **[内置MCP工具.md](内置MCP工具.md)** - 内置 MCP 工具
  - 可用的 MCP 工具列表
  - 工具使用示例

### API 密钥管理

- **[API密钥指南.md](API密钥指南.md)** - API 密钥指导
  - API 密钥配置指南
  - 安全最佳实践

- **[API密钥命令.md](API密钥命令.md)** - /apikey 命令
  - 命令使用说明
  - 示例

- **[API密钥修复总结.md](API密钥修复总结.md)** - API 密钥修复总结
  - 问题修复记录
  - 实现细节

## 🗂️ 文档分类

### 按用途分类

| 类型 | 文档 |
|------|------|
| 架构设计 | 结构.md |
| 迁移相关 | 单体仓库迁移指南.md, 迁移总结.md, 单体仓库自述.md |
| 开发相关 | 发布指南.md, 工具管理器优化.md |
| 变更记录 | 变更日志.md, 变更总结.md |
| MCP 集成 | MCP集成指南.md, MCP快速参考.md, 内置MCP工具.md |
| API 管理 | API密钥指南.md, API密钥命令.md, API密钥修复总结.md |

### 按受众分类

**面向用户：**
- 结构.md - 了解项目架构
- MCP集成指南.md - 配置 MCP 服务器
- API密钥指南.md - 配置 API 密钥

**面向开发者：**
- 单体仓库迁移指南.md - 了解 monorepo 结构
- 发布指南.md - 版本发布流程
- 工具管理器优化.md - 性能优化实现

**面向维护者：**
- 变更日志.md - 查看版本历史
- 内置MCP工具.md - MCP 工具清单
- API密钥修复总结.md - 问题修复记录

## 🔗 相关资源

- **项目主 README:** `../README.md`
- **Claude 配置:** `../CLAUDE.md`
- **包文档:**
  - nanopencil: `../packages/nanopencil/README.md`
  - nanomem: `../packages/nanomem/README.md`

## 📝 贡献文档

如需添加或更新文档，请遵循以下准则：

1. 使用清晰的文件命名
2. 在本文档中添加索引
3. 保持文档与代码同步更新
4. 使用 Markdown 格式编写

---

**最后更新:** 2025-03-04
