Files
NeoBot/docs/index.md
K2cr2O1 56b1014419 refactor(core): 重构核心模块结构并添加开发文档
将核心模块按功能重新组织为更清晰的结构,包括 managers、handlers 和 utils 目录
添加完整的开发文档,涵盖快速开始、项目结构、核心概念和插件开发指南
更新所有相关模块的导入路径以匹配新的结构
将单例模式实现提取到单独的 singleton.py 文件
2026-01-07 22:51:27 +08:00

1.8 KiB
Raw Blame History

NEO Bot Framework 开发文档

欢迎来到 NEO Bot Framework 的官方开发文档。

本文档旨在为开发者提供一个清晰、全面的指南,帮助您理解框架的设计理念、核心功能,并快速上手插件开发。

📖 文档结构

本站点的文档分为以下几个主要部分:

  • 基础入门

  • 核心概念

    • 事件流转: 深入理解一个事件从接收到处理的完整生命周期。
    • 单例管理器: 了解框架中核心管理器(如 CommandManager, PermissionManager)的设计与使用。
  • 插件开发

    • 基础指南: 学习如何创建一个插件,包括元数据定义和热重载工作流。
    • 指令处理: 掌握如何使用 @matcher.command() 装饰器注册和处理聊天指令。
  • 部署

    • 部署指南: 了解如何在生产环境中部署和维护机器人。

🤝 如何贡献

我们欢迎任何形式的贡献,无论是代码提交、文档修正还是功能建议。

  • 报告问题: 如果您在使用中遇到任何问题或 Bug请通过内部渠道提交 Issue。
  • 提交代码: 请遵循项目的编码规范,并通过 Pull Request 流程提交您的代码。
  • 完善文档: 如果您发现文档中有任何错误或遗漏,可以直接提出修改建议。

我们希望这份文档能让您的开发之旅更加顺畅。如果您有任何疑问,请随时与我们联系。