feat(docs): 更新文档,添加项目结构和部署指南,优化快速上手部分
This commit is contained in:
@@ -1,39 +1,38 @@
|
||||
# NEO Bot 开发文档
|
||||
|
||||
嘿,朋友,欢迎来到 NEO Bot
|
||||
欢迎来到 NEO Bot Framework 开发文档!
|
||||
|
||||
这里没那么多规矩。这份文档是我写给你——未来的插件开发者、或者单纯好奇想拆开看看的家伙——的一份地图
|
||||
这是一个现代化的 Python QQ 机器人框架,基于 OneBot v11 协议,采用异步架构和性能优化技术。无论你是想快速搭建机器人,还是深入了解框架设计,这份文档都能帮助你。
|
||||
|
||||
|
||||
## 📖 地图导览
|
||||
## 📖 文档导览
|
||||
|
||||
### 1. 准备阶段
|
||||
* [快速上手](./getting-started.md): 搭环境、装东西、启动。跟着走一遍,能省不少事。
|
||||
* [项目怎么样](./project-structure.md): 看看各个文件夹都是干嘛的,免得迷路。
|
||||
* [生产环境](./deployment.md): 怎么把你调教好的 Bot 扔服务器上,让它自己 7x24 小时跑。
|
||||
### 🚀 快速开始
|
||||
* [快速上手](./getting-started.md) - 5分钟搭建开发环境
|
||||
* [项目结构](./project-structure.md) - 了解代码组织方式
|
||||
* [生产部署](./deployment.md) - 将Bot部署到服务器
|
||||
|
||||
### 2. 核心探秘
|
||||
* [骨架](./core-concepts/architecture.md): 看看镀铬酸钾和python打架,嗯。。。
|
||||
* [性能优化](./core-concepts/performance.md): 页面池、JIT、Mypyc...
|
||||
* [消息流](./core-concepts/event-flow.md): 看看一条消息从被接收到被回复是如何运行的
|
||||
* [核心](./core-concepts/singleton-managers.md): `matcher`, `browser_manager`... 认识这些核心模块。
|
||||
* [Redis 原子操作与数据一致性](./core-concepts/redis-atomic-operations.md): 权限管理系统的原子操作实现,确保数据一致性
|
||||
* [错误处理](./core-concepts/error-handling.md): 了解系统的错误处理机制和错误码定义。
|
||||
### 💡 核心概念
|
||||
* [架构设计](./core-concepts/architecture.md) - 了解框架的设计理念
|
||||
* [性能优化](./core-concepts/performance.md) - JIT、Mypyc、页面池等优化技术
|
||||
* [事件流程](./core-concepts/event-flow.md) - 一条消息从接收到回复的完整流程
|
||||
* [核心管理器](./core-concepts/singleton-managers.md) - matcher、权限管理、浏览器池等
|
||||
* [Redis原子操作](./core-concepts/redis-atomic-operations.md) - 权限管理的分布式实现
|
||||
* [错误处理](./core-concepts/error-handling.md) - 异常处理和错误码体系
|
||||
|
||||
### 3. API 参考
|
||||
* [API 总览](./api/index.md): 所有 API 的快速导航和调用方式
|
||||
* [消息 API](./api/message.md): 发消息、撤回、转发、合并转发
|
||||
* [群组 API](./api/group.md): 管群、禁言、踢人、改名片
|
||||
* [好友 API](./api/friend.md): 好友列表、点赞、加好友请求
|
||||
* [账号 API](./api/account.md): 机器人自己的信息、状态设置
|
||||
* [媒体 API](./api/media.md): 图片、语音相关
|
||||
### 🔌 API 参考
|
||||
* [API 总览](./api/index.md) - API 调用方式和快速导航
|
||||
* [消息 API](./api/message.md) - 发送、撤回、转发消息
|
||||
* [群组 API](./api/group.md) - 群管理、禁言、踢人等
|
||||
* [好友 API](./api/friend.md) - 好友列表、点赞等
|
||||
* [账号 API](./api/account.md) - 机器人自身信息获取
|
||||
* [媒体 API](./api/media.md) - 图片、语音、视频处理
|
||||
|
||||
### 4. 插件开发
|
||||
* [插件开发第一步](./plugin-development/index.md): 带你写第一个插件
|
||||
* [指南](./plugin-development/command-handling.md): 怎么教你的 Bot 听懂指令和参数。
|
||||
* [绝对不要做的事情](./plugin-development/best-practices.md): **(必读!)**
|
||||
### 📚 插件开发
|
||||
* [插件入门](./plugin-development/index.md) - 写你的第一个插件
|
||||
* [指令处理](./plugin-development/command-handling.md) - 参数解析、权限控制等
|
||||
* [最佳实践](./plugin-development/best-practices.md) - 避免常见的坑
|
||||
* [插件案例:状态监控](./plugin-development/status-plugin.md) - 深入学习复杂插件实现
|
||||
|
||||
## 贡献
|
||||
|
||||
发现 Bug 了?觉得文档写得烂?
|
||||
直接提 Issue 或者 PR。代码质量是第一位的,Talk is cheap, show me the code.
|
||||
### 📋 开发规范
|
||||
* [开发规范](./development-standards.md) - 代码风格、异步编程、错误处理规范
|
||||
|
||||
Reference in New Issue
Block a user