update docs

Author: wu-clan

docs/.vuepress/components/Swiper.vue

@@ -25,6 +25,7 @@ import "swiper/css/effect-flip";
 import "swiper/css/effect-coverflow";
 import "swiper/css/effect-cards";
 import "swiper/css/effect-creative";
+import { defaultSponsor, shouldShowSponsor } from "../data/sponsors";
 
 interface SlideItem {
   /**
@@ -39,7 +40,7 @@ interface SlideItem {
 }
 
 interface Props {
-  items?: (string | SlideItem)[];
+  items?: SlideItem[];
   width?: number | string; // 轮播区域宽度，单位 px
   height?: number | string; // 轮播区域高度，单位 px
   mode?: "banner" | "carousel" | "broadcast"; // banner: 轮播图模式; carousel: 走马灯模式; broadcast: 信息展播模式
@@ -65,9 +66,15 @@ const props = withDefaults(defineProps<Props>(), {
   swipe: true
 });
 
+const sponsors = computed(() => {
+  return props.items.map(brand => {
+    return shouldShowSponsor(brand) ? brand : defaultSponsor;
+  });
+});
+
 const slideList = computed<SlideItem[]>(() => {
   return (
-      props.items?.map((link) => {
+      sponsors.value?.map((link) => {
         if (typeof link === "string") return { link };
         return link;
       }) ?? []

docs/backend/reference/schema.md

@@ -12,6 +12,7 @@ fba 遵循以下命名规范：
 - 接口入参：`XxxParam()`
 - 新增入参：`CreateXxxParam()`
 - 更新入参：`UpdateXxxParam()`
+- 批量删除入参：`DeleteXxxParam()`
 - 查询详情：`GetXxxDetail()`
 - 查询详情（包含关系）：`GetXxxWithRelationDetail()`
 

docs/backend/summary/quick-start.md

@@ -9,7 +9,10 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 ## 本地开发
 
 ::: tip
-如果您是 PostgreSQL 用户，请先移步到 [切换数据库](../reference/db.md)
+
+- 雪花主键 ID 用户，请先移步到 [切换主键](../reference/pk.md)
+- PostgreSQL 用户，请先移步到 [切换数据库](../reference/db.md)
+
 :::
 
 :::: steps
@@ -18,7 +21,7 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
     - Python 3.10+
     - MySQL 8.0+ 或 PostgreSQL 16.0 +
-    - Redis 推荐最新稳定版
+    - <p>Redis 推荐最新稳定版</p>
 
 2. 准备 Git 仓库 <Badge type="warning" text="二选一" />
 
@@ -90,7 +93,7 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
        :::
 
        ::: caution
-       为了实现插件 0 耦合，插件依赖并未使用 uv 进行管理。执行上面脚本文件后，如果后期您仍需同步环境依赖，请务必使用命令：
+       为了实现插件 0 耦合，插件依赖未使用 uv 进行管理。执行上面脚本文件后，如果后期您仍需同步环境依赖，请务必使用命令：
        `uv sync --frozen --inexact`，否则插件依赖将被 uv 自动清理！
        :::
 
@@ -115,7 +118,7 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
    ::: tabs
    @tab 自动创建
-   直接启动后端项目
+   跳过此步骤，启动 fba 后将自动创建
 
    @tab Alembic 迁移
    生成迁移文件
@@ -129,9 +132,6 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
    ```shell:no-line-numbers
    alembic upgrade head
    ```
-
-   @tab SQL 脚本
-   执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
    :::
 
 9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选，三个都可以不执行" />
@@ -141,29 +141,24 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
    ::: code-tabs
    @tab Worker
 
-   ```shell:no-line-numbers
-   celery -A app.task.celery worker -l info
-   ```
+    ```shell:no-line-numbers
+    celery -A app.task.celery worker -l info
+    ```
 
    @tab Beat
 
-   ```shell:no-line-numbers
-   celery -A app.task.celery beat -l info
-   ```
+    ```shell:no-line-numbers
+    celery -A app.task.celery beat -l info
+    ```
 
    @tab Flower
 
-   ```shell:no-line-numbers
-   celery -A app.task.celery flower --port=8555 --basic-auth=admin:123456
-   ```
-
+    ```shell:no-line-numbers
+    celery -A app.task.celery flower --port=8555 --basic-auth=admin:123456
+    ```
    :::
 
-10. 初始化测试数据
-
-    执行 `backend/sql/init_test_data.sql` 脚本初始化测试数据
-
-11. 启动
+10. 启动
 
     在 `backend` 目录打开终端，执行以下命令启动 FastAPI 服务
 
@@ -175,6 +170,10 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
     此项目默认使用 CLI 启动服务，为了方便本地调试，你仍然可以选择在 IDE 中右键运行 `run.py` 文件
     :::
 
+11. 初始化测试数据
+
+    通过 `backend/sql/` 目录下对应主键模式的脚本初始化测试数据
+
 12. 打开浏览器访问：[http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs)
 
 ::::
@@ -207,9 +206,9 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 
 ::: steps
 
-1. 创建测试数据库 `fba_test`，选择 utf8mb4 编码，postgres 用户可忽略编码
-2. 创建数据库表，执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
-3. 初始化测试数据，执行 `backend/sql/` 目录下对应数据库的 `init_test_data.sql` 脚本
+1. 创建测试数据库 `fba_test`，选择 utf8mb4 编码，postgresql 用户可忽略编码
+2. 创建数据库表，利用工具创建 `fba` 库所有表的 DDL 脚本，再通过 `fba_test` 库执行
+3. 初始化测试数据，通过 `backend/sql/` 目录下对应主键模式的脚本初始化测试数据
 4. 在项目根目录打开终端，执行以下单元测试命令
 
    ```shell:no-line-numbers

docs/plugin/before.md

@@ -10,7 +10,7 @@ title: 前言
 
 提供一个共创平台，告别高耦合集成，让功能变得可轻松 Hot Swap（热插拔）
 
-遗憾的是，我们并不会提供插件管理平台对插件进行统一管理，我们计划将所有插件在 [插件市场](market.md) 进行展示和导航
+遗憾的是，我们并不会提供插件管理平台对插件进行统一管理，我们计划将所有插件在 [插件市场](../market.md) 进行展示和导航
 
 ## 开发
 

docs/plugin/dev.md

@@ -57,11 +57,11 @@ fba 会在启动前对所有插件进行解析
 [plugin]
 # 摘要（简短描述）
 summary = ''
-# 插件版本号
+# 版本号
 version = ''
-# 插件描述
+# 描述
 description = ''
-# 插件作者
+# 作者
 author = ''
 
 # 应用配置
@@ -77,11 +77,11 @@ router = ['']
 [plugin]
 # 摘要（简短描述）
 summary = ''
-# 插件版本号
+# 版本号
 version = ''
-# 插件描述
+# 描述
 description = ''
-# 插件作者
+# 作者
 author = ''
 
 # 应用配置

docs/plugin/install.md

@@ -2,24 +2,13 @@
 title: 快速开始
 ---
 
-您可以将 [插件市场](./market.md) 中的插件通过以下方式进行安装：
+您可以将 [插件市场](../market.md) 中的插件通过以下方式进行安装：
 
 :::: tabs
 @tab 手动
 
 1. 获取插件仓库源码并下载
-2. 拷贝插件代码
-
-   ::: tabs
-   @tab 后端
-
-   将下载的源码文件夹直接拷贝到 `backend/plugin` 目录下
-
-   @tab 前端
-
-   暂无此计划...
-   :::
-
+2. 将下载的源码文件夹直接拷贝到 `backend/plugin` 目录下
 3. 如果插件包含依赖（requirements.txt），执行 `backend/scripts/init_plugin.py` 文件安装依赖
 4. 根据插件说明（README.md）进行相关配置
 5. 重启服务
@@ -28,11 +17,13 @@ title: 快速开始
 
 1. 获取打包好的插件 zip 压缩包 <Badge type="warning" text="二选一" />
 
-    - 下载插件仓库为 zip 压缩包，例如 GitHub
+    - 下载插件仓库为 zip 压缩包
 
+      ::: details GitHub 示例
       ![zip](/images/plugin_zip.png)
+      :::
 
-    - 通过 fba 插件打包接口下载的 zip 压缩包
+    - 通过 fba 插件下载接口下载的 zip 压缩包
 
 2. 将 zip 压缩包通过 zip 插件安装接口进行安装
 3. 根据插件说明（README.md）进行相关配置

docs/plugin/share.md

@@ -11,28 +11,28 @@ title: 插件分享
 
    `个人插件仓库名 == 插件名`
 
-   当我们创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件名作为仓库名使用，这样，插件将符合 fba 内置规则，并允许通过
+   ::: warning
+   创建个人插件仓库的时候，应将 `backend/plugin` 目录下的插件（文件夹）名作为仓库名使用，这样，插件将符合 fba 内置规则，并允许通过
    git 快捷安装
 
-   ::: warning
    插件总是独一无二的，不允许安装同名插件，所以我们在对插件进行命名时，应尽量保持其独特性
    :::
 
    ![repo](/images/plugin_template.png)
 
 2. 上传代码
 
-   将本地插件中的所有文件拷贝到个人插件仓库中
+   将本地插件文件夹中的所有文件拷贝到个人插件仓库中
 
    ::: caution
-   应拷贝插件目录下的所有文件，而不是直接拷贝插件目录
+   应拷贝插件文件夹中的所有文件，而不是直接拷贝插件目录
    :::
 
 ::::
 
 ## 公开
 
-我们为插件创建了一个 [插件市场](market.md)，用于展示和导航
+我们为插件创建了一个 [插件市场](../market.md)，用于展示和导航
 
 如果您开发的插件与 fba 兼容，欢迎在 Discord
 社区的 [插件系统](https://discord.com/channels/1185035164577972344/1349951379560599572) 频道与我们分享