diff --git a/docs/en/dev/guide.md b/docs/en/dev/guide.md index f6af536a..3a0b7bbf 100644 --- a/docs/en/dev/guide.md +++ b/docs/en/dev/guide.md @@ -21,6 +21,25 @@ If you need to submit code to the Liteyuki repository, please read the following - During development, you can use tools such as `mypy`, `flake8`, and `black` for code checking and formatting. - Enable developer mode by setting `dev_mode: true` in `config.yml` to see more debugging information in the console. +## Project Structure +- `main.py`: Bot entry file +- `liteyuki`: Framework directory (liteyukibot) +- `src`: Bot application source code directory + - `liteyuki_plugins`: Liteyuki plugin directory + - `nonebot_plugins`: Nonebot plugin directory + - `resources`: Built-in resource packs directory + - `utils`: Utility directory +- `tests`: Unit test directory +- `docs`: Documentation directory + - `en`: English documentation + - `zh`: Chinese documentation +- `docker`: Docker related content directory + +The `liteyuki` framework is included in the `LiteyukiBot` application, so this project is both the `LiteyukiBot` application repository and the `liteyuki` framework repository. + +The `src` directory is the application part, please develop business logic in this directory. `liteyuki_plugins` and `nonebot_plugins` directories are plugin directories, please develop plugins in these directories. + + ## Standardization - Code should follow [`PEP8`](https://pep8.org/) and [`Google Python Style Guide`](https://google.github.io/styleguide/pyguide.html). - In addition, code submitted to the Liteyuki repository should follow the following guidelines: diff --git a/docs/en/index.md b/docs/en/index.md index 5062606e..0cb9138e 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -7,13 +7,13 @@ hero: tagline: "An integrated chat bot application and management framework" actions: - theme: brand - text: Get Started + text: 🚀 Get Started link: ./deploy/install - theme: alt - text: Manual + text: 📖 Manual link: ./usage/basic - theme: alt - text: Extensions + text: 📦 Extensions link: ./store/ image: diff --git a/docs/zh/dev/guide.md b/docs/zh/dev/guide.md index a884914a..de9eb273 100644 --- a/docs/zh/dev/guide.md +++ b/docs/zh/dev/guide.md @@ -20,6 +20,24 @@ order: 0 - 开发过程中可以使用`mypy`, `flake8`, `black`等工具进行代码检查和格式化。 - 启用开发者模式,可以在`config.yml`中设置`dev_mode: true`,这样可以在控制台看到更多的调试信息。 +## 项目结构 +- `main.py`: 机器人入口文件 +- `liteyuki`: 框架目录(liteyukibot) +- `src`: 机器人源码目录 + - `liteyuki_plugins`: 轻雪插件目录 + - `nonebot_plugins`: Nonebot插件目录 + - `resources`: 内置资源包目录 + - `utils`: 工具目录 +- `tests`: 单元测试目录 +- `docs`: 文档目录 + - `en`: 英文文档 + - `zh`: 中文文档 +- `docker`: Docker相关内容目录 + +其中,`liteyuki`框架是包含在`LiteyukiBot`应用中的,所以此项目既是`LiteyukiBot`应用仓库,同时也是`liteyuki`框架的仓库 + +`src`目录下为应用程序部分,业务逻辑请在此目录下进行开发,`liteyuki_plugins`和`nonebot_plugins`目录下为插件目录,插件开发请在此目录下进行开发。 + ## 规范化 - 代码请遵循[`PEP8`](https://pep8.org/)和[`Google Python Style Guide`](https://google.github.io/styleguide/pyguide.html) - 此外,提交到轻雪仓库的代码,请遵循以下规范: diff --git a/docs/zh/index.md b/docs/zh/index.md index 0e9f6fc5..3778c746 100644 --- a/docs/zh/index.md +++ b/docs/zh/index.md @@ -7,13 +7,13 @@ hero: tagline: "一个综合性的机器人应用及管理框架" actions: - theme: brand - text: 快速开始 + text: 🚀 快速开始 link: ./deploy/install - theme: alt - text: 使用手册 + text: 📖 使用手册 link: ./usage/basic - theme: alt - text: 扩展 + text: 📦 扩展 link: ./store/resource image: light: ./liteyuki.svg