update docs

wu-clan · wu-clan · commit 24c6cdcefa59 · 2025-06-27T17:05:28.000+08:00
diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts
@@ -44,7 +44,7 @@ export const myNavbar = defineNavbarConfig([
         ]
     },
     {
-        text: 'v1.5.1',
+        text: 'v1.5.2',
         items: [
             {
                 text: '线上演示',
diff --git a/docs/frontend/arco.md b/docs/frontend/arco.md
@@ -10,10 +10,10 @@ badge:
 我们已于 2025 年 3 月 29 日对 Arco 仓库进行封存，此后它将不再接收任何更新。尽管做出这一决定让我们心生不舍，毕竟 Arco
 曾承载了我们无数的探索与期待，但技术的脚步永不停歇，为了顺应更高效、更前沿的发展需求，我们不得不迈向新的篇章。
 
-至此，承蒙每一位大佬的厚爱，请与我们携手共进，打开 [Vben Admin Antd](./intro.md) 新篇章吧
+至此，承蒙每一位大佬的厚爱，请与我们携手共进，打开 [Vben Admin Antd](./intro.md) 新篇章
 
 ::: note
-此实施内部通过硬编码实现了 Casbin RBAC 鉴权，解耦较为复杂，需手动删除 casbin、API 管理及其所有调用
+此实施内部通过硬编码实现了 Casbin RBAC 鉴权，如需解耦，需手动删除 casbin、API 管理及其所有调用
 :::
 
 ::: caution
diff --git a/docs/frontend/intro.md b/docs/frontend/intro.md
@@ -4,29 +4,8 @@ title: 介绍
 
 基于 Vben Admin Antd 构建的 fastapi_best_architecture 前端完整版实施
 
-::: info 施工进度
+::: warning
+fba 从始至终一直是企业级后端架构解决方案，并没有针对前端的专项计划，前端项目只是一项附加产物
 
-- [x] 验证码登录
-- [x] 菜单对接
-- [x] OAuth2
-- [x] 部门管理
-- [x] 用户管理
-- [x] 角色管理
-- [x] 菜单管理
-- [x] 插件管理
-- [x] 数据权限
-- [x] 登录日志
-- [x] 操作日志
-- [x] 系统监控
-- [x] Redis 监控
-- [ ] 代码生成
-- [x] SocketIO
-- [x] 在线用户
-- [ ] 通知公告
-- [ ] 字典数据
-- [ ] 参数配置
-- [ ] 定时任务
-- [x] 个人信息
-- [ ] ...
-
-:::
+我们的团队中没有专业的前端工程师，如果您都此项目的发展和实施有更好的见解，请直接创建 Issues 或 PR
+:::
diff --git a/docs/plugin/dev.md b/docs/plugin/dev.md
@@ -7,7 +7,7 @@ title: 插件开发
 ::: steps
 
 1. 拉取最新的 fba 项目到本地并配置好开发环境
-2. 通过 [插件分类](#插件分类)、[插件路由结构](#插件路由结构)、[插件配置](#插件配置)、[数据库兼容性](#数据库兼容性)
+2. 通过 [插件类型](#插件类型)、[插件路由](#插件路由)、[插件配置](#插件配置)、[数据库兼容性](#数据库兼容性)
    了解插件系统的运作机制
 3. 根据 [插件目录结构](#插件目录结构) 进行插件开发
 4. 完成插件开发
@@ -16,28 +16,30 @@ title: 插件开发
 
 :::
 
-### 插件分类
+### 插件类型
 
 ::: tabs#plugin
 @tab <Icon name="carbon:app" />应用级插件
 在 [项目结构](../backend/summary/intro.md#项目结构) 中，app
-目录下的一级文件夹被视为应用，此原理同样应用于插件系统。也就是说，如果插件被开发为应用，那么它们将会像应用一样被注入到系统中，我们称这类插件为【应用级插件】
+目录下的一级文件夹被视为应用，此原理同样应用于插件系统。
+
+此类插件会像应用一样被注入到系统中，我们称这类插件为【应用级插件】
 
 @tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
-与【应用级插件】相反，如果插件不被开发为应用，那么它们将被开发为 app 目录下已存在应用的扩展功能，我们称这类插件为【扩展级插件】
+此类插件会被注入到 app 目录下已存在的应用中，我们称这类插件为【扩展级插件】
 :::
 
-### 插件路由结构
+### 插件路由
 
 如果插件符合插件开发的要求，则插件中的所有路由都将自动注入到 FastAPI 应用中。但值得注意的是，启动时间可能会随着插件数量的递增而增加，因为
-fba 会在启动前对所有插件进行解析
+fba 会在每次启动前对所有插件进行实时解析
 
 ::: tabs#plugin
 @tab <Icon name="carbon:app" />应用级插件
-插件路由结构应完全遵循 [路由结构](../backend/reference/router.md#路由结构) 进行开发
+应完全遵循 [路由结构](../backend/reference/router.md#路由结构) 进行开发
 
 @tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
-插件路由结构必须根据现有应用中的目录结构进行 1:1 复制，可参考 fba
+必须将应用中的 api 目录结构进行 1:1 复制，可参考 fba
 中的内置插件 [notice](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend/plugin/notice/api)
 :::
 
@@ -46,7 +48,7 @@ fba 会在启动前对所有插件进行解析
 `plugin.toml` 是插件的配置文件，每个插件都必须包含此文件
 
 ::: caution
-此配置文件自 fba v1.3.0 版本起发生重大变更，仅向后兼容（低于此版本开发的插件将不可用）
+此配置文件自 fba v1.5.3 版本起发生重大变更，仅向后兼容（低于此版本开发的插件将不可用）
 :::
 
 ::: tabs#plugin
@@ -66,8 +68,9 @@ author = ''
 
 # 应用配置
 [app]
-# 插件路由器实例，可参考源码：backend/app/admin/api/router.py，通常默认命名为 v1
-router = ['']
+# 路由器最终实例
+# 可参考源码：backend/app/admin/api/router.py，通常默认命名为 v1
+router = ['v1']
 ```
 
 @tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
@@ -86,17 +89,17 @@ author = ''
 
 # 应用配置
 [app]
-# 此插件属于哪个 app
-include = ''
+# 扩展的哪个应用
+extend = '应用文件夹名称'
 
 # 接口配置
-# xxx 对应的是插件 api 目录下的接口文件名（不包含后缀）
-# 例如接口文件名为 notice.py，则 xxx 应该为 notice
-# 如果包含多个接口文件，则应存在多个相应的 api 配置
 [api.xxx]
-# xxx 路由前缀，必须以 '/' 开头
+# xxx 对应的是插件 api 目录下接口文件的文件名（不包含后缀）
+# 例如接口文件名为 notice.py，则 xxx 应该为 notice
+# 如果包含多个接口文件，则应存在多个接口配置
+# 路由前缀，必须以 '/' 开头
 prefix = ''
-# 标签，用于 FastAPI 接口文档
+# 标签，用于 Swagger 文档
 tags = ''
 ```
 
@@ -116,23 +119,52 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
 
 - xxx 插件名 <Badge type="danger" text="必须" />
     - api/ 接口 <Badge type="danger" text="必须" />
-    - crud/ CRUD <Badge type="warning" text="非必须" />
-    - model 模型 <Badge type="warning" text="非必须" />
-        - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
+    - crud/ CRUD
+    - model 模型
+        - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="目录存在则必须" />
         - …
-    - schema/ 数据传输 <Badge type="warning" text="非必须" />
-    - service/ 服务 <Badge type="warning" text="非必须" />
-    - utils/ 工具包 <Badge type="warning" text="非必须" />
+    - schema/ 数据传输
+    - service/ 服务
+    - utils/ 工具包
     - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
-    - … 更多内容，例如 enums.py... <Badge type="warning" text="非必须" />
+    - … 更多内容，例如 enums.py...
     - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
     - README.md 插件使用说明和您的联系方式 <Badge type="danger" text="必须" />
-    - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />
+    - requirements.txt 依赖包文件
 
 :::
 
+::: warning
+非必要情况下，不建议引用架构中的现有方法，如果现有方法变更，则插件也必须同步变更，否则插件将不可用
+:::
+
 ## 前端
 
-::: warning
-暂无此计划...
+::: steps
+
+1. 拉取最新的 fba_ui 项目到本地并配置好开发环境
+2. 根据 [插件目录结构](#插件目录结构-1) 进行插件开发
+3. 完成插件开发
+
+4. [插件分享](./share.md) <Badge type="warning" text="可选" />
+
 :::
+
+### 插件目录结构
+
+插件统一放置在 `apps/web-antd/src/plugins` 目录下，以下是插件的目录结构
+
+::: file-tree
+
+- xxx 插件名
+    - api/ 接口
+    - langs 多语言
+        - en-US
+            - 插件名.json
+        - zh-CN
+            - 插件名.json
+    - routes/ 路由
+    - views/ 视图
+    - … 更多内容
+
+:::
diff --git a/docs/plugin/install.md b/docs/plugin/install.md
@@ -1,8 +1,12 @@
 ---
-title: 快速开始
+title: 插件安装
 ---
 
-您可以将 [插件市场](../market.md) 中的插件通过以下方式进行安装：
+::: caution
+切勿在线上环境直接安装插件，以免带来不必要的损失
+:::
+
+## 后端
 
 :::: tabs
 @tab 手动
@@ -43,13 +47,8 @@ title: 快速开始
 文件（如果存在）中的主键模式是否与你当前正在使用的主键模式相匹配，参考：[切换主键](../backend/reference/pk.md)
 :::
 
-::: caution
-无论采用哪种安装方式，fba 服务都不会实时热重载，您必须重新启动，插件功能才能被正确加载到 FastAPI 应用中
-
-原因：
-
-1. 实时热重载是非线程安全模式，它会影响正在处理中的任务
-2. 插件可能包含环境变量配置，增加安全风险
-3. 频繁热重载可能引发内存泄漏
+## 前端
 
-:::
+1. 获取插件仓库源码并下载
+2. 将下载的源码文件夹直接拷贝到 `apps/web-antd/src/plugins` 目录下
+3. 重启服务
diff --git a/docs/plugin/share.md b/docs/plugin/share.md
@@ -2,6 +2,8 @@
 title: 插件分享
 ---
 
+## 后端
+
 :::: steps
 
 1. 创建个人插件仓库
@@ -12,8 +14,7 @@ title: 插件分享
    `个人插件仓库名 == 插件名`
 
    ::: warning
-   创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件（文件夹）名作为仓库名使用，这样，插件将符合 fba 内置规则，并允许通过
-   git 快捷安装
+   创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件（文件夹）名作为仓库名使用
 
    插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
    :::
@@ -30,6 +31,33 @@ title: 插件分享
 
 ::::
 
+## 前端
+
+:::: steps
+
+1. 创建个人插件仓库
+
+   使用插件模板仓库 [fba_ui_plugin_template](https://github.com/fastapi-practices/fba_ui_plugin_template)
+   创建个人插件仓库，个人插件仓库命名请遵循以下规则：
+
+   `个人插件仓库名 == 插件名_ui`
+
+   ::: warning
+   创建个人插件仓库的时候，应将 `apps/web-antd/src/plugins` 目录下的插件（文件夹）名作为仓库名使用
+
+   插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
+   :::
+
+2. 上传代码
+
+   将本地插件文件夹中的所有文件拷贝到个人插件仓库中
+
+   ::: caution
+   应拷贝插件文件夹中的所有文件，而不是直接拷贝插件目录
+   :::
+
+::::
+
 ## 公开
 
 我们为插件创建了一个 [插件市场](../market.md)，用于展示和导航

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ export const myNavbar = defineNavbarConfig([`
`44`	`44`	`]`
`45`	`45`	`},`
`46`	`46`	`{`
`47`		`- text: 'v1.5.1',`
	`47`	`+ text: 'v1.5.2',`
`48`	`48`	`items: [`
`49`	`49`	`{`
`50`	`50`	`text: '线上演示',`