Readme
nanobot 学习文档索引
📚 本目录包含了完整的 nanobot 项目学习文档
📖 文档列表
入门文档
- 00-学习指南总览.md - 从这里开始,了解整体学习路线
- 学习路线图.md - 可视化的学习路径和知识依赖图
- 快速参考手册.md - API 和命令速查表
核心学习文档
第一层:项目结构(新手)
- 01-项目结构与架构.md - 理解整体架构和目录结构
- 02-CLI命令入口.md - 了解命令行使用方式 (待创建)
第二层:核心概念(初级)
- 03-配置系统.md - 配置文件的加载与管理 (待创建)
- 04-消息总线.md - 解耦的消息传递机制 (待创建)
第三层:Agent 核心(中级)
- 05-Agent核心循环.md - 智能体的核心处理引擎
- 06-上下文构建.md - 如何组装提示词 (待创建)
- 07-会话管理.md - 对话历史的存储 (待创建)
第四层:工具系统(中级)
- 08-工具系统架构.md - 工具的设计与实现
- 09-内置工具详解.md - 文件、Shell、Web 等工具 (待创建)
第五层:高级特性(高级)
- 10-技能系统.md - 可扩展的技能机制 (待创建)
- 11-子代理系统.md - 后台任务处理 (待创建)
- 12-记忆系统.md - 长期记忆管理 (待创建)
第六层:多渠道集成(高级)
- 13-渠道管理.md - Telegram、WhatsApp 集成 (待创建)
- 14-定时任务.md - Cron 调度系统 (待创建)
- 15-心跳机制.md - 主动唤醒功能 (待创建)
第七层:扩展开发(专家)
- 16-开发自定义工具.md - 创建新工具 (待创建)
- 17-开发自定义技能.md - 创建新技能 (待创建)
- 18-代码对比分析.md - nanobot vs Clawdbot
🎯 推荐阅读顺序
新手路径(2-3 小时)
系统学习路径(1-2 天)
按照文档编号顺序阅读:00 → 01 → 02 → … → 18
开发者路径(3-5 天)
- 快速浏览 00-08
- 深入学习 16-18
- 参考快速参考手册.md进行实践
📊 文档统计
- 已完成:7 篇
- 待创建:11 篇
- 总计:18 篇核心文档 + 3 篇辅助文档
🔗 相关资源
项目资源
外部资源
💡 使用建议
如何阅读
- 第一次:快速浏览,了解大致内容
- 第二次:仔细阅读,配合源码理解
- 第三次:实践操作,验证理解
如何实践
- 安装 nanobot:
pip install -e . - 初始化配置:
nanobot onboard - 边学边做:每学一个概念就动手试试
如何求助
- 查看源码:最权威的答案
- 查看测试:了解使用方式
- 社区讨论:Discord / GitHub Issues
📝 贡献指南
如果你想为文档做贡献:
- Fork 项目
- 创建或完善文档
- 提交 Pull Request
文档格式要求:
- 使用 Markdown 格式
- 包含代码示例
- 清晰的结构和标题
- 必要的图表(Mermaid 语法)
📅 更新日志
- 2026-02-03:创建初始文档框架
- 完成:00, 01, 05, 08, 18, 学习路线图, 快速参考手册
- 待完成:02-04, 06-07, 09-17
开始学习:👉 00-学习指南总览.md
需要帮助:👉 快速参考手册.md
深入理解:👉 按顺序阅读所有文档
祝学习愉快!🎓