update docs

Author: wu-clan

docs/.vuepress/navbar.ts

@@ -5,7 +5,7 @@ export const myNavbar = defineNavbarConfig([
         text: 'UI 效果',
         items: [
             {
-                text: 'Git 仓库',
+                text: 'GitHub',
                 icon: 'mdi:git',
                 items: [
                     {
@@ -14,7 +14,7 @@ export const myNavbar = defineNavbarConfig([
                     },
                     {
                         text: 'Vben Admin Antd 下一代实施',
-                        link: 'https://github.com/fastapi-practices/fba_ui'
+                        link: 'https://github.com/fastapi-practices/fba_admin'
                     }
                 ]
             },

docs/guide/deploy/Docker.md

@@ -20,27 +20,40 @@ title: Docker 部署
 
 ::: steps
 
-1. 确保你位于项目根目录
-2. 运行以下命令构建容器
+1. env
+
+   在 `backend` 目录中，创建环境变量文件
+
+   ```shell
+   touch .env
+   ```
+
+   将初始化环境变量配置拷贝到环境变量文件中
+
+   ```shell
+   cp .env.example .env
+   ```
+
+2. 按需修改配置文件 `backend/core/conf.py` 和 `.env`
+3. 确保你位于项目根目录
+4. 运行以下命令构建容器
+
+   如果容器要在本地启动，需要将 `.env` 中的 `127.0.0.1` 更改为 `host.docker.internal`
 
    ```shell
    docker build -f backend/Dockerfile -t fba_backend_independent .
    ```
 
-3. 启动容器
+5. 启动容器
 
-   本机启动需要将 `.env` 中的 `127.0.0.1` 更改为 `host.docker.internal`
+   由于构建不包含数据库，请确保本地已安装并启动相关数据库（mysql / postgresql、redis）
 
    ```shell
    docker run -d -p 8000:8000 --name fba_server fba_backend_independent
    ```
 
 :::
 
-### 前端
-
-无前端本地部署方案，请转至文档 [本地开发](../summary/quick-start.md#本地开发)
-
 ## 服务器部署
 
 > [!TIP]
@@ -67,7 +80,7 @@ title: Docker 部署
 
    ::: note
    我们在 docker-compose 脚本内通过挂载的方式直接使用此文件作为 fba 环境变量文件，因此，本地修改此文件，将同步更新至 docker
-   容器，这意味着，修改环境变量将无需重新 build 
+   容器，这意味着，修改环境变量将无需重新 build
    :::
 
    ::: warning
@@ -85,7 +98,7 @@ title: Docker 部署
 
 4. 更新脚本文件
 
-   ```yaml :collapsed-lines
+   ```yaml :collapsed-lines=6
    services:
      fba_server:
        build:
@@ -187,7 +200,7 @@ title: Docker 部署
      # 如果你选择单独构建，务必注释或删除此容器脚本
      fba_ui: # [!code warning:30]
        build:
-         context: /root/fastapi_best_architecture_ui  # 根据 fba_ui 项目存放目录修改此路径
+         context: /root/fastapi_best_architecture_ui  # 根据 Arco Desgin Vue 项目存放目录修改此路径
          dockerfile: Dockerfile
        image: fba_ui:latest
        ports:
@@ -300,23 +313,18 @@ title: Docker 部署
 2. env
 
    :::: details Arco Desgin Vue
-
-   ::: caution
-   这是一个实验性实施，它仅用作效果演示，而不是用于生产！
-   :::
-
    修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
    ::::
 
    :::: details Vben Admin Antd
-   我知道你很急，但你先别急...
+   即将到来...
    ::::
 
 3. 更新 nginx 配置
 
    进入 deploy 目录，修改 `nginx.conf` 文件
 
-   ```nginx :collapsed-lines
+   ```nginx :collapsed-lines=6
    # For more information on configuration, see:
    #   * Official English Documentation: http://nginx.org/en/docs/
    #   * Official Russian Documentation: http://nginx.org/ru/docs/
@@ -409,7 +417,7 @@ title: Docker 部署
    如果你已通过后端 docker-compose 构建前端项目，此步骤和后面的剩余步骤直接跳过即可
    :::
 
-   ```yaml :collapsed-lines
+   ```yaml :collapsed-lines=6
    networks:
      fba_network:
        external: true
@@ -442,7 +450,7 @@ title: Docker 部署
           # local_ssl_key_path: 你在服务器存放 ssl key 证书文件的路径，自行修改
           # /etc/ssl/xxx.pem：挂载到容器内 ssl pem 证书文件的路径，自行修改
           # /etc/ssl/xxx.key：挂载到容器内 ssl key 证书文件的路径，自行修改
-         - local_ssl_pem_path:/etc/ssl/xxx.pem # [!code warning:3]
+         - local_ssl_pem_path:/etc/ssl/xxx.pem # [!code warning:2]
          - local_ssl_key_path:/etc/ssl/xxx.key
          - fba_static:/www/fba_server/backend/static
        networks:
@@ -477,6 +485,10 @@ title: Docker 部署
 不建议频繁使用 `docker-compose up -d --build` 命令，此命令每次执行都会重新构建容器，并将原容器自动本地备份保留，这会导致硬盘空间迅速锐减
 :::
 
+::: info
+[15 个 Docker 容器自动化管理的脚本](https://www.yuque.com/fcant/devops/itkfyytisf9z84y6)
+:::
+
 清理未使用的镜像
 
 ```shell

docs/guide/reference/db.md

@@ -3,21 +3,21 @@ title: 切换数据库
 ---
 
 ::: tip
-此教程仅适用于 pg 用户
+此教程仅适用于 PostgreSQL 用户
 :::
 
 fba 支持 MySQL、PostgreSQL 两种数据库，默认配置使用 MySQL
 
-如果本地未安装 pg，你可以使用以下命令创建 Docker 镜像
+如果本地未安装 PostgreSQL，你可以使用以下命令创建 Docker 镜像
 
 ```shell
 docker run -d --name fba_postgres --restart always -e POSTGRES_DB='fba' -e POSTGRES_PASSWORD='123456' -e TZ='Asia/Shanghai' -v fba_postgres:/var/lib/postgresql/data -p 5432:5432 postgres:16
 ```
 
 ## 默认配置
 
-pg 与 MySQL 在用户名、端口号等方面有所不同，如果你使用上面的命令创建了 Docker 镜像，需修改 `.env` 部分配置如下，否则，请根据
-pg 配置进行修改
+PostgreSQL 与 MySQL 在用户名、端口号等方面有所不同，如果你使用上面的命令创建了 Docker 镜像，需修改 `.env` 部分配置如下，否则，请根据
+PostgreSQL 配置进行修改
 
 ```env
 # Database

docs/guide/reference/router.md

@@ -14,7 +14,7 @@ fba 中的路由遵循 Restful API 规范
 
 - backend 后端
     - app 应用
-        - xxx 自定义应用（包含子包）
+        - xxx 自定义应用 <Badge type="warning" text="包含子包" />
             - api 接口
                 - v1
                     - xxx 子包
@@ -23,7 +23,7 @@ fba 中的路由遵循 Restful API 规范
                         - ...
                 - __init\_\_.py
                 - router.py 在此文件内注册所有子包 __init\_\_.py 文件中的路由
-        - xxx 自定义应用（不包含子包）
+        - xxx 自定义应用 <Badge type="warning" text="不包含子包" />
             - api 接口
                 - v1
                     - _\_init\_\_.py 不做任何操作

docs/guide/summary/intro.md

@@ -2,9 +2,6 @@
 title: 简介
 ---
 
-> [!TIP]
-> 此仓库作为模板库公开，任何个人或企业均可免费使用！
-
 ## 伪三层架构
 
 mvc 架构作为常规设计模式，在 python web 中很常见，但是三层架构更令人着迷

docs/guide/summary/quick-start.md

@@ -68,7 +68,7 @@ title: 快速开始
 
       执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
 
-4. 创建数据库：`fba`，选择 utf8mb4 编码，postgres 用户可忽略编码
+4. 创建数据库：`fba`，选择 utf8mb4 编码，PostgreSQL 用户可忽略编码
 5. 启动 Redis
 6. env
 
@@ -84,7 +84,7 @@ title: 快速开始
    cp .env.example .env
    ```
 
-7. 按需修改配置文件 `core/conf.py` 和 `.env`
+7. 按需修改配置文件 `backend/core/conf.py` 和 `.env`
 8. 创建数据库表（三选一）
 
     - 直接启动后端项目（自动创建）
@@ -159,15 +159,15 @@ title: 快速开始
 
 ### 前端
 
-::: tip
+::: warning
 前端项目并不是我们发展的重心，我们创建的所有前端实施，均用于 UI
 效果演示，它们不一定适用于生产环境，您可以点击查看我们的 [目标](./why.md#目标)
 :::
 
 ::::: details Arco Desgin Vue
 
 ::: caution
-这是一个实验性实施，它仅用作效果演示，而不是用于生产！
+这是一个实验性实施，仅用于效果演示，此版本即将存档，请勿将其用于生产！
 :::
 
 :::: steps
@@ -207,8 +207,8 @@ title: 快速开始
 
 ::::: details Vben Admin Antd
 
-::: warning
-这是下一代实施，目前正处于积极开发阶段
+::: tip
+这是下一代实施，目前正处于积极开发阶段，未来将完全适配 fba
 :::
 
 1. 准备本地环境
@@ -219,7 +219,7 @@ title: 快速开始
 2. 拉取 Git 项目
 
    ```shell
-   git clone https://github.com/fastapi-practices/fba_ui.git
+   git clone https://github.com/fastapi-practices/fba_admin.git
    ```
 
 3. 安装和启动

docs/guide/summary/why.md

@@ -6,8 +6,11 @@ title: 为什么选择我们？
 import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 </script>
 
+> [!TIP]
+> 此仓库作为模板库公开，任何个人或企业均可免费使用！
+
 ::: note
-我们不会去对比其他架构，我们认为每个架构都有自己的特点，适合不同的场景。
+我们不会去对比任何其他架构，我们认为每个架构都有自己的特点，适用于不同的场景。
 
 但 fba 绝对是开源架构中代码最干净，最规范且最令人赏心悦目的项目之一
 :::
@@ -168,8 +171,8 @@ fba
 
   我们有十分严格的 CI
   代码质量检测和[规则](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/.ruff.toml)
-  ，使用非常流行且强大的 ruff 作为支撑，为每次 PR 的代码质量做到严格把控
+  ，使用非常流行且强大的 Ruff 作为支撑，为每次 PR 的代码质量做到严格把控
 
 - 持续的认可
 
-  在此我们不做任何宣传引导，您可以在交流群发出疑问，我们静待用户真实反馈
+  在此我们不做任何宣传引导，您可以在任意社区/交流群发出疑问，我们静待用户真实反馈

docs/plugin/dev.md

@@ -48,18 +48,19 @@ title: 插件开发
     - plugin 固定目录
         - xxx 插件名
             - api/ 接口，务必查看下方 [接口路由](#插件路由)
-            - crud/ CRUD（非必须项）
-            - model 模型（非必须项）
+            - crud/ CRUD <Badge type="warning" text="非必须" />
+            - model 模型 <Badge type="warning" text="非必须" />
                 - \_\_init__.py 必须在此文件内导入所有模型类
                 - …
-            - schema/ 数据传输（非必须项）
-            - service/ 服务（非必须项）
-            - utils/ 工具包（非必须项）
-            - \_\_init__.py 作为 python 包保留（必须项）
-            - conf.py 常量配置（非必须项）
-            - plugin.toml 插件配置文件（必须项）
-            - README.md 插件使用说明（必须项）
-            - requirements.txt 依赖包文件（非必须项）如果插件需要安装依赖，则必须
+            - schema/ 数据传输 <Badge type="warning" text="非必须" />
+            - service/ 服务 <Badge type="warning" text="非必须" />
+            - utils/ 工具包 <Badge type="warning" text="非必须" />
+            - \_\_init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
+            - conf.py 常量配置 <Badge type="warning" text="非必须" />
+            - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
+            - README.md 插件使用说明 <Badge type="danger" text="必须" />
+            - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />
+              如果插件需要安装依赖，则为 <Badge type="danger" text="必须" />
 
 :::
 

docs/plugin/market.md

@@ -13,10 +13,9 @@ title: 插件市场
 - <Badge type="info" text="free" /> - 免费插件
 - <Badge type="danger" text="pay" /> - 付费插件
 - <Badge type="tip" text="fba" /> - 仅后端代码插件
-- <Badge text="fba-arco" color="#4582ff"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 代码插件
-- <Badge text="fba-vben" color="#c178ec"/> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui) 代码插件
+- <Badge text="fba + vben" color="#c178ec"/> - 包含前端 [fba_admin](https://github.com/fastapi-practices/fba_admin) 代码插件
 - <Badge text="app" color="#ff9900"/> - 应用级插件
-- <Badge text="app-extra" color="#11aa00"/> - 扩展级插件
+- <Badge text="extra" color="#11aa00"/> - 扩展级插件
 
 :::
 
@@ -30,23 +29,23 @@ title: 插件市场
     <span>
     <Badge type="info" text="free" />
     <Badge type="tip" text="fba" />
-    <Badge text="app-extra" color="#11aa00"/>
+    <Badge text="extra" color="#11aa00"/>
     </span>
   </LinkCard>
   <LinkCard icon="solar:user-check-bold" title="Casbin-RBAC" href="https://discord.com/channels/1185035164577972344/1340300371251302451">
     <p style="color: #898989;">添加基于 Casbin 实现的 RBAC 权限</p>
     <span>
     <Badge type="info" text="free" />
     <Badge type="tip" text="fba" />
-    <Badge text="app-extra" color="#11aa00"/>
+    <Badge text="extra" color="#11aa00"/>
     </span>
   </LinkCard>
   <LinkCard icon="ant-design:aliyun-outlined" title="阿里云 oss" href="https://discord.com/channels/1185035164577972344/1342478204400832593">
     <p style="color: #898989;">添加阿里云 oss 上传文件功能</p>
     <span>
     <Badge type="info" text="free" />
     <Badge type="tip" text="fba" />
-    <Badge text="app-extra" color="#11aa00"/>
+    <Badge text="extra" color="#11aa00"/>
     </span>
   </LinkCard>
 </CardGrid>

docs/plugin/publish.md

@@ -6,7 +6,7 @@ title: 发布
 > 插件作者需符合以下几点要求
 >
 > - 必须加入 Discord 社区
-> - 必须提供插件仓库 github 地址
+> - 必须提供插件仓库 GitHub 地址
 > - 必须在插件仓库 README 文件内提供至少一种（任意）联系方式
 
 ::: warning