update docs

Author: wu-clan

docs/.vuepress/bulletin.ts

@@ -5,5 +5,5 @@ export const myBulletin: BulletinOptions = {
     lifetime: 'session',
     contentType: 'markdown',
     title: 'FasAPI 最佳架构',
-    content: '欢迎大家闲聊，分享，提供建议，高频艾特，你们的活跃度是我更新的动力 🌹',
+    content: '欢迎大家加入 Discord 社区闲聊，分享，提供建议，高频艾特，你们的活跃度是我更新的动力 🌹',
 }

docs/.vuepress/config.ts

@@ -29,21 +29,21 @@ export default defineUserConfig({
     ],
     theme: plumeTheme({
         hostname: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/',
+        logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
+        docsRepo: 'https://github.com/fastapi-practices/fastapi_best_architecture_docs',
+        docsBranch: 'master',
+        docsDir: 'docs',
         blog: false,
         notes: false,
+        bulletin: myBulletin,
+        sidebar: mySidebar,
+        sidebarScrollbar: false,
+        navbar: myNavbar,
         autoFrontmatter: {
             title: true,
             permalink: false,
             createTime: false,
         },
-        bulletin: myBulletin,
-        sidebar: mySidebar,
-        sidebarScrollbar: false,
-        navbar: myNavbar,
-        logo: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.png',
-        docsRepo: 'https://github.com/fastapi-practices/fastapi_best_architecture_docs',
-        docsBranch: 'master',
-        docsDir: 'docs',
         social: [
             {icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture'},
             {
@@ -56,8 +56,7 @@ export default defineUserConfig({
             {icon: 'discord', link: 'https://discord.com/invite/yNN3wTbVAC'}
         ],
         navbarSocialInclude: ['github', 'gitee', 'discord'],
-        editLinkText: '在 GitHub 上编辑此页面',
-        lastUpdated: false,
+        editLinkText: '编辑此页面',
         contributors: false,
         copyright: {
             license: {
@@ -68,28 +67,27 @@ export default defineUserConfig({
         footer: {
             copyright: 'Copyright © 2024-present FastAPI Practices'
         },
-        plugins: {
-            shiki: {
-                languages: ['shell', 'yaml', 'py']
-            },
-            // watermark: true,
-            markdownPower: {
-                abbr: true,
-                annotation: true,
-                icons: true,
-            },
-            markdownEnhance: {
-                mermaid: true,
-            },
-            comment: {
-                provider: 'Giscus',
-                comment: true,
-                repo: 'fastapi-practices/fastapi_best_architecture_docs',
-                repoId: 'R_kgDOMv5sMQ',
-                category: 'Comment',
-                categoryId: 'DIC_kwDOMv5sMc4CmLp9',
-                lazyLoading: true,
-            },
+        // watermark: false,
+        markdown: {
+            alert: true,
+            abbr: true,
+            annotation: true,
+            mermaid: true,
+        },
+        codeHighlighter: {
+            themes: {
+                dark: 'one-dark-pro',
+                light: 'one-light'
+            }
+        },
+        comment: {
+            provider: 'Giscus',
+            comment: true,
+            repo: 'fastapi-practices/fastapi_best_architecture_docs',
+            repoId: 'R_kgDOMv5sMQ',
+            category: 'Comment',
+            categoryId: 'DIC_kwDOMv5sMc4CmLp9',
+            lazyLoading: true,
         },
     }),
     bundler: viteBundler(),

docs/.vuepress/navbar.ts

@@ -33,6 +33,11 @@ export const myNavbar = defineNavbarConfig([
     {
         text: 'v1.0.3',
         items: [
+            {
+                text: '常见问题',
+                icon: 'healthicons:question',
+                link: '/questions.md'
+            },
             {
                 text: '技术支持',
                 icon: 'fluent-emoji-high-contrast:unicorn',

docs/.vuepress/public/images/plugin_zip.png

@@ -2,12 +2,6 @@
 title: Docker 部署
 ---
 
-::: warning
-默认端口冲突：8000、3306、6379、5672、5432
-
-如果 docker 容器启动时端口被占用，会导致启动失败，建议在启动前检查本地端口占用情况
-:::
-
 ::: info
 一个还不错的教程网站：[Docker - 从入门到实践](https://yeasy.gitbook.io/docker_practice)
 :::
@@ -85,7 +79,7 @@ title: Docker 部署
 
    ::: warning
    如果你需要使用 PostgreSQL 数据库，执行命令前，需修改 `.env.server` 部分配置如下：
-   ```env:no-line-numbers
+   ```text:no-line-numbers
    # Database
    DATABASE_TYPE='postgresql'
    DATABASE_HOST='fba_postgres'

docs/guide/deploy/Docker.md

@@ -77,7 +77,7 @@ fba 中默认使用此鉴权方式
 
    内置模型 `backend/plugin/casbin/utils/rbac.py`：
 
-    ```model
+    ```text:no-line-numbers
     [request_definition]
     r = sub, obj, act
 

docs/guide/reference/RBAC.md

@@ -19,7 +19,7 @@ docker run -d --name fba_postgres --restart always -e POSTGRES_DB='fba' -e POSTG
 PostgreSQL 与 MySQL 在用户名、端口号等方面有所不同，如果你使用上面的命令创建了 Docker 镜像，需修改 `.env` 部分配置如下，否则，请根据
 PostgreSQL 配置进行修改
 
-```env:no-line-numbers
+```text:no-line-numbers
 # Database
 DATABASE_TYPE='postgresql'
 DATABASE_HOST='127.0.0.1'

docs/guide/reference/db.md

@@ -28,27 +28,23 @@ title: 快速开始
     * MySQL 8.0+ 或 PostgreSQL 16.0 +
     * Redis 推荐最新稳定版
 
-2. 准备 Git 仓库
+2. 准备 Git 仓库 <Badge type="warning" text="二选一" />
 
-   ::: note
-   两种方案，选择其中一种即可
-   :::
-
-    1. 拉取源代码仓库
-
-       此方式需要你删除拉取项目后根目录下的 `.git` 文件夹，之后上传到你指定的仓库即可，具体请自行查阅你要上传平台的行为准则
+   ::: tabs
+   @tab 拉取源代码
 
-       ```shell:no-line-numbers
-       git clone https://github.com/fastapi-practices/fastapi_best_architecture.git
-       ```
+   ```shell:no-line-numbers
+   git clone https://github.com/fastapi-practices/fastapi_best_architecture.git
+   ```
 
-    2. 创建模板仓库
+   @tab 创建模板仓库
 
-       此项目支持创建模板仓库，意味着，你可以直接创建一个非 fork（独立无绑定的关系）的个人仓库，如果所示，进入此项目
-       GitHub 首页，
-       使用 `use this template` 按钮创建即可，创建完成之后，使用 `git clone` 命令拉取你自己的仓库即可
+   此项目支持创建模板仓库，意味着，你可以直接创建一个非 fork 的个人仓库，如图所示，进入此项目
+   GitHub 首页，
+   使用 `use this template` 按钮创建即可，创建完成之后，使用 `git clone` 命令拉取你自己的仓库即可
 
-       ![use_this_template](/images/use_this_template.png)
+   ![use_this_template](/images/use_this_template.png)
+   :::
 
 3. 安装依赖包
 
@@ -57,7 +53,12 @@ title: 快速开始
       拉取项目到本地后，在项目根目录，执行以下命令安装架构依赖
 
       ::: code-tabs
-      @tab <Icon name="material-icon-theme:uv" />uv
+      @tab <Icon name="material-icon-theme:uv" />uv - pip
+      ```shell:no-line-numbers
+      uv pip install -r requirements.txt
+      ```
+      
+      @tab <Icon name="material-icon-theme:uv" />uv - sync
       ```shell:no-line-numbers
       uv sync --frozen
       ```
@@ -72,11 +73,11 @@ title: 快速开始
 
       执行 `backend/scripts/init_plugin.py` 文件安装插件依赖
 
-4. 创建数据库：`fba`，选择 utf8mb4 编码，PostgreSQL 用户可忽略编码
+4. 创建数据库：`fba`，选择 utf8mb4 编码；PostgreSQL 用户可忽略编码
 5. 启动 Redis
 6. env
 
-   在 `backend` 目录中，创建环境变量文件
+   在 `backend` 目录打开终端，执行以下命令创建环境变量文件
 
    ```shell:no-line-numbers
    touch .env
@@ -89,7 +90,7 @@ title: 快速开始
    ```
 
 7. 按需修改配置文件 `backend/core/conf.py` 和 `.env`
-8. 创建数据库表（三选一）
+8. 创建数据库表 <Badge type="warning" text="三选一" />
 
    ::: tabs
    @tab 自动创建
@@ -112,6 +113,8 @@ title: 快速开始
 
 9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选" />
 
+   在 `backend` 目录打开终端，执行以下创建启动 celery 相关服务
+
    ::: code-tabs
    @tab Worker
    ```shell:no-line-numbers

docs/guide/summary/quick-start.md

@@ -8,9 +8,9 @@ title: vscode
 
 ## DEBUG
 
-以下是 vscode 中的 launch.json 配置
+如果你想在 vscode 中对 fba 进行调试，请创建 `.vscode/launch.json` 文件并添加以下配置
 
-```json5
+```json
 {
   "version": "0.2.0",
   "configurations": [

docs/guide/summary/vscode.md

@@ -12,7 +12,7 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 ::: note
 我们不会去对比任何其他架构，我们认为每个架构都有自己的特点，适用于不同的场景。
 
-但 fba 绝对是开源架构中代码==最干净，最规范且最令人赏心悦目=={.note}的项目之一
+但 fba 绝对是开源架构中==代码最干净，最规范且最令人赏心悦目的项目之一=={.note}
 :::
 
 ## 目标

docs/guide/summary/why.md

@@ -11,7 +11,7 @@ title: 知识星球
 
 ::: details 如果您觉得还不错，欢迎正式加入订阅
 <div align="center">
-  <p style="color: #fd7600">我们在节假日会在 Discord 统一发送大额优惠券，敬请关注</p>
+  <p style="color: #fd7600">我们在节假日会在 Discord 社区统一发送大额优惠券，敬请关注</p>
   <img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
 </div>
 :::

docs/planet.md

@@ -34,4 +34,4 @@ title: 前言
 
 ## 免责声明
 
-但对于付费插件作者跑路行为，我们不承担任何责任
+对于付费插件作者跑路行为，我们无需承担任何责任