feat: 添加性能优化和架构文档,更新依赖和核心模块
refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖
This commit is contained in:
@@ -2,33 +2,27 @@
|
||||
|
||||
欢迎来到 NEO Bot Framework 的官方开发文档。
|
||||
|
||||
本文档旨在为开发者提供一个清晰、全面的指南,帮助您理解框架的设计理念、核心功能,并快速上手插件开发。
|
||||
这里没有废话,只有干货。这份文档会教你如何驾驭这个基于 Python 3.14 的高性能机器人框架。
|
||||
|
||||
## 📖 文档结构
|
||||
|
||||
本站点的文档分为以下几个主要部分:
|
||||
### 1. 基础入门
|
||||
* [快速上手](./getting-started.md): 环境配置、安装、启动。别跳过,除非你想报错。
|
||||
* [项目结构](./project-structure.md): 了解各个目录是干嘛的。
|
||||
* [部署指南](./deployment.md): 怎么在服务器上长期运行。
|
||||
|
||||
* **基础入门**
|
||||
* [快速上手](./getting-started.md): 从零开始配置和运行您的第一个机器人实例。
|
||||
* [项目结构解析](./project-structure.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` 等核心组件。
|
||||
|
||||
* **核心概念**
|
||||
* [事件流转](./core-concepts/event-flow.md): 深入理解一个事件从接收到处理的完整生命周期。
|
||||
* [单例管理器](./core-concepts/singleton-managers.md): 了解框架中核心管理器(如 `CommandManager`, `PermissionManager`)的设计与使用。
|
||||
### 3. 插件开发
|
||||
* [基础指南](./plugin-development/index.md): 怎么写一个最简单的插件。
|
||||
* [指令处理](./plugin-development/command-handling.md): 怎么注册命令、解析参数。
|
||||
* [最佳实践](./plugin-development/best-practices.md): **重要!** 避免写出卡死机器人的垃圾代码。
|
||||
|
||||
* **插件开发**
|
||||
* [基础指南](./plugin-development/index.md): 学习如何创建一个插件,包括元数据定义和热重载工作流。
|
||||
* [指令处理](./plugin-development/command-handling.md): 掌握如何使用 `@matcher.command()` 装饰器注册和处理聊天指令。
|
||||
## 🤝 贡献
|
||||
|
||||
* **部署**
|
||||
* [部署指南](./deployment.md): 了解如何在生产环境中部署和维护机器人。
|
||||
|
||||
## 🤝 如何贡献
|
||||
|
||||
我们欢迎任何形式的贡献,无论是代码提交、文档修正还是功能建议。
|
||||
|
||||
* **报告问题**: 如果您在使用中遇到任何问题或 Bug,请通过内部渠道提交 Issue。
|
||||
* **提交代码**: 请遵循项目的编码规范,并通过 Pull Request 流程提交您的代码。
|
||||
* **完善文档**: 如果您发现文档中有任何错误或遗漏,可以直接提出修改建议。
|
||||
|
||||
我们希望这份文档能让您的开发之旅更加顺畅。如果您有任何疑问,请随时与我们联系。
|
||||
发现 Bug 了?觉得文档写得烂?
|
||||
直接提 Issue 或者 PR。代码质量是第一位的,Talk is cheap, show me the code.
|
||||
|
||||
Reference in New Issue
Block a user