docs: 更新文档内容,简化语言并修正格式

- 简化插件开发指南中的描述,移除冗余内容
- 调整部署文档中的Python版本说明
- 优化最佳实践文档的措辞和格式
- 更新性能优化文档,删除不准确的数据
- 重构核心概念文档,使用更简洁的语言
- 修正README中的项目描述和技术栈说明
- 更新快速上手文档,简化安装步骤
- 调整事件流转文档的描述方式
- 简化架构文档内容
- 更新指令处理文档,添加参数注入示例
- 优化单例管理器文档的表述
This commit is contained in:
2026-01-13 04:49:03 +08:00
parent 7880f0f928
commit 7f331970dd
11 changed files with 213 additions and 172 deletions

View File

@@ -1,28 +1,29 @@
# NEO Bot Framework 开发文档
# NEO Bot 开发文档
欢迎来到 NEO Bot Framework 的官方开发文档。
嘿,朋友,欢迎来到 NEO Bot
这里没有废话,只有干货。这份文档会教你如何驾驭这个基于 Python 3.14 的高性能机器人框架。
这里没那么多规矩。这份文档是我写给你——未来的插件开发者、或者单纯好奇想拆开看看的家伙——的一份地图
## 📖 文档结构
### 1. 基础入门
* [快速上手](./getting-started.md): 环境配置、安装、启动。别跳过,除非你想报错。
* [项目结构](./project-structure.md): 了解各个目录是干嘛的。
* [部署指南](./deployment.md): 怎么在服务器上长期运行。
## 📖 地图导览
### 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` 等核心组件。
### 1. 准备阶段
* [快速上手](./getting-started.md): 搭环境、装东西、启动。跟着走一遍,能省不少事
* [项目怎么样](./project-structure.md): 看看各个文件夹都是干嘛的,免得迷路
* [生产环境](./deployment.md): 怎么把你调教好的 Bot 扔服务器上,让它自己 7x24 小时跑
### 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`... 认识这些核心模块。
### 3. 插件开发
* [基础指南](./plugin-development/index.md): 怎么写一个最简单的插件
* [令处理](./plugin-development/command-handling.md): 怎么注册命令、解析参数。
* [最佳实践](./plugin-development/best-practices.md): **重要!** 避免写出卡死机器人的垃圾代码。
* [插件开发第一步](./plugin-development/index.md): 带你写第一个插件
* [](./plugin-development/command-handling.md): 怎么教你的 Bot 听懂指令和参数。
* [绝对不要做的事情](./plugin-development/best-practices.md): **(必读!)**
## 🤝 贡献
## 贡献
发现 Bug 了?觉得文档写得烂?
直接提 Issue 或者 PR。代码质量是第一位的Talk is cheap, show me the code.