update docs

wu-clan · wu-clan · commit e7ec4357014d · 2024-12-29T01:09:50.000+08:00
diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts
@@ -10,7 +10,7 @@ export const myNavbar = defineNavbarConfig([
                 //link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
             },
             {
-                text: 'Ant Desgin Vue 孵化中...',
+                text: 'Vben Admin Antd 生产中...',
                 link: 'https://github.com/fastapi-practices/fba_ui'
             }
         ]
diff --git a/docs/.vuepress/public/images/code-generator1.png b/docs/.vuepress/public/images/code-generator1.png
diff --git a/docs/.vuepress/public/images/code-generator2.png b/docs/.vuepress/public/images/code-generator2.png
diff --git a/docs/.vuepress/public/images/code-generator3.png b/docs/.vuepress/public/images/code-generator3.png
diff --git a/docs/guide/deploy/Docker.md b/docs/guide/deploy/Docker.md
@@ -293,14 +293,14 @@ title: Docker 部署
    :::: details Arco Desgin Vue
    
    ::: caution
-   这是一个实验版本，它仅用作效果演示，而不是用于生产！
+   这是一个实验性实施，它仅用作效果演示，而不是用于生产！
    :::
    
    修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
    ::::
 
-   :::: details Ant Desgin Vue
-   生产可用？我知道你很急，但你先别急...
+   :::: details Vben Admin Antd
+   我知道你很急，但你先别急...
    ::::
 
 3. 更新 nginx 配置
diff --git a/docs/guide/mixin/user.md b/docs/guide/mixin/user.md
@@ -3,19 +3,12 @@ title: 用户信息
 ---
 
 <div align="center">
-此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
 <a href="https://t.zsxq.com/virtV">内容跳转</a>
 
-<span style="color: rgb(110, 110, 110);">
-我们不保证星球内容的更新频率，您可以依据星球规则进行全额退款
-</span>
+此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
-<p style="font-size: 14px; color: rgb(110,110,110);">
-附：星球用作
-<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
-，加入 Discord 社区，可领取免费体验资格
-</p>
+附：星球用作 [有偿赞助](../../sponsors.md#有偿赞助)，加入 Discord 社区，即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
 
 <img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
 
diff --git a/docs/guide/reference/celery.md b/docs/guide/reference/celery.md
@@ -3,19 +3,12 @@ title: Celery
 ---
 
 <div align="center">
-此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
 <a href="https://t.zsxq.com/qk5gZ">内容跳转</a>
 
-<span style="color: rgb(110, 110, 110);">
-我们不保证星球内容的更新频率，您可以依据星球规则进行全额退款
-</span>
+此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
-<p style="font-size: 14px; color: rgb(110,110,110);">
-附：星球用作
-<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
-，加入 Discord 社区，可领取免费体验资格
-</p>
+附：星球用作 [有偿赞助](../../sponsors.md#有偿赞助)，加入 Discord 社区，即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
 
 <img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
 
diff --git a/docs/guide/reference/code-generation.md b/docs/guide/reference/code-generation.md
@@ -3,16 +3,15 @@ title: 代码生成
 ---
 
 > [!TIP]
-> 当前版本仅包含后端代码生成
->
-> 代码生成器使用 api 调用实现，包含两个模组，设计可能存在缺陷，相关问题请直接提交 issues
+> 当前版本仅包含后端代码生成，代码生成器使用 api 调用实现，设计可能存在缺陷，相关问题请直接提交 issues
 
 > [!WARNING]
-> 由于 jinja2 在渲染模版时，文本方式输出可能存在格式问题，所以 `preview` 接口可能无法直观预览代码，这是为前端进行的预设，
-> 你可以在我们的在线预览中更加直观的查看生成效果
+> api 调用无法直观的预览代码生成结果，它必须配合前端项目使用，查看 [效果预览](#效果预览)
 
 ## 概念
 
+代码生成包含【业务】和【模型】两个模块
+
 ### 业务
 
 包含代码生成的相关配置，详情查看：`generator/model/gen_business.py`
@@ -21,20 +20,28 @@ title: 代码生成
 
 包含代码生成所需要的模型列信息，就像正常定义模型列一样，目前支持的功能有限
 
-## 使用
+## 工作模式
 
-### F. 纯手动模式
+目前包含两种工作模式，分别为手动和自动，手动已被标记为弃用，推荐使用自动模式
 
-不推荐（手动创建业务接口被标记为「已弃用」）
+### 手动
 
 1. 通过创建业务接口手动添加一项业务数据
 2. 通过模型创建接口手动添加模型列
-3. 访问 `preview`（预览），`generate`（磁盘写入），`download`（下载）接口，执行后端代码生成相应工作
+3. 访问 `preview`（预览）、`generate`（磁盘写入）、`download`（下载）接口
+
+### 自动
+
+1. 访问 `tables` 接口，自动获取数据库表名列表
+2. 访问 `import` 接口，导入数据库已有的数据库表，自动创建业务表数据和模型表数据
+3. 访问 `preview`（预览）、`generate`（磁盘写入）、`download`（下载）接口
+
+## 效果预览
 
-### S. 自动模式
+::: details Arco Desgin Vue
+![cg1](/images/code-generator1.png)
 
-推荐
+![cg2](/images/code-generator2.png)
 
-1. 访问 `tables` 接口，获取数据库表名列表
-2. 通过 `import` 接口，导入数据库已有的数据库表数据，将自动创建业务表数据和模型表数据
-3. 访问 `preview`（预览），`generate`（磁盘写入），`download`（下载）接口，执行后端代码生成相应工作
+![cg3](/images/code-generator3.png)
+:::
diff --git a/docs/guide/reference/data-rule.md b/docs/guide/reference/data-rule.md
@@ -3,19 +3,12 @@ title: 数据规则
 ---
 
 <div align="center">
-此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
 <a href="https://t.zsxq.com/qlZyT">内容跳转</a>
 
-<span style="color: rgb(110, 110, 110);">
-我们不保证星球内容的更新频率，您可以依据星球规则进行全额退款
-</span>
+此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
-<p style="font-size: 14px; color: rgb(110,110,110);">
-附：星球用作
-<a href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E6%9C%89%E5%81%BF%E8%B5%9E%E5%8A%A9">有偿赞助</a>
-，加入 Discord 社区，可领取免费体验资格
-</p>
+附：星球用作 [有偿赞助](../../sponsors.md#有偿赞助)，加入 Discord 社区，即可 [领取免费体验资格](https://discord.com/invite/yNN3wTbVAC)
 
 <img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
 
diff --git a/docs/guide/summary/quick-start.md b/docs/guide/summary/quick-start.md
@@ -150,7 +150,7 @@ title: 快速开始
 ::::: details Arco Desgin Vue
 
 ::: caution
-这是一个实验版本，它仅用作效果演示，而不是用于生产！
+这是一个实验性实施，它仅用作效果演示，而不是用于生产！
 :::
 
 :::: steps
@@ -182,10 +182,8 @@ title: 快速开始
 ::::
 :::::
 
-::::: details Ant Desgin Vue
-
-生产可用？我知道你很急，但你先别急...
-
+::::: details Vben Admin Antd
+我知道你很急，但你先别急...
 :::::
 
 ## 开发流程
diff --git a/docs/guide/summary/why.md b/docs/guide/summary/why.md
@@ -29,7 +29,7 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 
 自创建此项目以来，我们已为此项目付出了大量的时间，并且，这仍然在继续！
 
-![Commits_over_time.png](/images/Commits_over_time.png)
+![commits_over_time.png](/images/commits_over_time.png)
 
 ## 框架由来
 
diff --git a/docs/sponsors.md b/docs/sponsors.md
@@ -16,8 +16,10 @@ FBA 基于 MIT 开源协议，您可以查看我们的[授权协议](/guide/summ
 
 ## 有偿赞助
 
-您可以加入我们创建的[知识星球](https://t.zsxq.com/PDk8b)，获取星球内提供的独家内容，另外，我们会为您添加 Discord
-身份标签，以便于后期进行活动投票，线上指导，远程支持等等...
+您可以加入我们创建的 [知识星球](https://t.zsxq.com/PDk8b)，获取星球内提供的独家内容，另外，我们会为您添加 Discord
+身份标签，以便于后期进行活动投票，线上指导，远程支持等等... 
+
+请注意，我们不保证星球内容的更新频率，您可以==依据星球规则进行全额退款==
 
 ## 展位赞助商
 
diff --git a/docs/who.md b/docs/who.md
@@ -7,8 +7,8 @@ title: 谁在使用？
 > 进行项目开发，我们诚挚的邀请您参与：[用户登记](https://github.com/fastapi-practices/fastapi_best_architecture/issues/477)
 >
 > 1. **无偿登记**：您的登记完全免费，我们郑重承诺，并且绝对不会在任何阶段向您收取任何形式的使用费用，也不会将您的信息用于商业盈利或其他非公开目的
-> 2. **优先支持**：登记后，您将被视为我们的优质用户，我们的维护团队将优先响应并解决您在实际使用过程中遇到的问题
-> 3. **官方认可**：您有机会在我们的官方网站上获得高亮展示，让更多人了解您的项目或公司
+> 2. **优先支持**：登记后，您将被视为我们的优质用户，我们的维护团队将优先响应您在实际使用过程中遇到的问题
+> 3. **官方认可**：您会在我们的官方网站上获得集中展示，让更多人有机会了解您的公司或项目
 >
 > 在进行用户调研时，一个常见且关键的问题是：==此项目有人应用在生产环境中吗？==
 > 面对这样的询问，仅仅依赖口头回答往往显得苍白无力，而使用登记数据则更为直观且有力，至此，我们再次非常诚挚的邀请您参与用户登记
@@ -27,5 +27,10 @@ title: 谁在使用？
 ## 开源项目
 
 <CardGrid>
-  <LinkCard icon="https://wu-clan.github.io/picx-images-hosting/logo/fba.png" title="fastapi_sqlalchemy_mysql" href="https://github.com/wu-clan/fastapi_sqlalchemy_mysql" description="fastapi + pydantic-v2 + sqlalchemy 2.0 + alembic + mysql + redis" />
+  <LinkCard 
+  icon="https://wu-clan.github.io/picx-images-hosting/logo/fba.png" 
+  title="fastapi_sqlalchemy_mysql" 
+  href="https://github.com/wu-clan/fastapi_sqlalchemy_mysql" 
+  description="fastapi + pydantic-v2 + sqlalchemy 2.0 + alembic + mysql + redis" 
+  />
 </CardGrid>

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ export const myNavbar = defineNavbarConfig([`
`10`	`10`	`//link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'`
`11`	`11`	`},`
`12`	`12`	`{`
`13`		`- text: 'Ant Desgin Vue 孵化中...',`
	`13`	`+ text: 'Vben Admin Antd 生产中...',`
`14`	`14`	`link: 'https://github.com/fastapi-practices/fba_ui'`
`15`	`15`	`}`
`16`	`16`	`]`