update docs

Author: wu-clan

docs/.vuepress/bulletin.ts

@@ -6,13 +6,13 @@ export const myBulletin: BulletinOptions = {
     content: `
 ::: center
 
-**知识星球：** [玩转 FBA，不止 FBA](https://t.zsxq.com/sDbws)
+**Discord 服务器：** [Python 开发交流社区](https://discord.com/invite/yNN3wTbVAC)
 
 <hr>
 
-<p style="font-size: 14px; color: rgb(160, 160, 160);">加入 <a href="https://discord.gg/yNN3wTbVAC">Discord</a> 频道，即可领取免费体验机会，更有大额优惠券随机发放，先到先得！</p>
+<p style="font-size: 14px; color: rgb(160, 160, 160);">加入并订阅此服务器，即可尊享闲聊，技术分享，疑难杂症解答，与大佬肩并肩，速速行动吧！</p>
 
-<img src="https://wu-clan.github.io/picx-images-hosting/知识星球.png">
+<iframe src="https://discord.com/widget?id=1185035164577972344&theme=dark" width="350" height="500" allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>
 
 :::
 `,

docs/.vuepress/config.ts

@@ -2,7 +2,7 @@ import {myNavbar} from "./navbar";
 import {mySidebar} from "./sidebar";
 import {defineUserConfig} from "vuepress";
 import plumeTheme from "vuepress-theme-plume";
-import { viteBundler } from '@vuepress/bundler-vite'
+import {viteBundler} from '@vuepress/bundler-vite'
 import {myBulletin} from "./bulletin";
 
 
@@ -11,7 +11,7 @@ export default defineUserConfig({
     lang: 'zh-CN',
     title: 'FastAPI Best Architecture',
     head: [
-        ['link', {rel: 'icon', href: 'https://fastapi.tiangolo.com/img/favicon.png'}]
+        ['link', {rel: 'icon', href: 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg'}]
     ],
     theme: plumeTheme({
         blog: false,
@@ -24,14 +24,15 @@ export default defineUserConfig({
         bulletin: myBulletin,
         sidebar: mySidebar,
         navbar: myNavbar,
-        logo: 'https://fastapi.tiangolo.com/img/favicon.png',
+        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' }
+            {icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture'},
+            {icon: 'discord', link: 'https://discord.com/invite/yNN3wTbVAC'}
         ],
-        navbarSocialInclude: ['github'],
+        // navbarSocialInclude: ['github'],
         editLinkText: '在 GitHub 上编辑此页面',
         // lastUpdated: {
         //     text: 'Releases',
@@ -42,14 +43,14 @@ export default defineUserConfig({
         },
         plugins: {
             shiki: {
-                languages: ['shell','yaml','py']
+                languages: ['shell', 'yaml', 'py']
             },
             watermark: true,
             markdownPower: {
                 icons: true,
                 bilibili: true,
             },
-        }
+        },
     }),
     bundler: viteBundler(),
 })

docs/guide/README.md

@@ -100,7 +100,7 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 
 ## 相关
 
-<RepoCard repo="fastapi-practices/sqlalchemy-crud-plus" />
+<RepoCard repo="wu-clan/sqlalchemy-crud-plus" />
 
 ::: tip 特别鸣谢
 本文档由 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)

docs/guide/mixin/user.md

@@ -2,28 +2,14 @@
 title: Mixin
 ---
 
-我们默认提供的所有模型都是没有操作人员信息的，在很多项目中，可能会添加每条数据的创建人、更新人，
-虽然我们没有实行这一特性，但是，我们提供了非常简易的集成方式
+<div align="center">
 
-## 如何应用？
+此内容为非公开内容，扫码加入知识星球，即可获取独家内容
 
-在 `common/model.py` 文件中，我们提供了用户 Mixin 类
+但请注意，我们并不保证星球内容更新频率，您可以依据星球规则进行全额退款
 
-```py
-class UserMixin(MappedAsDataclass):
-    """用户 Mixin 数据类"""
+<p style="color: rgb(160, 160, 160);">注：加入的 Discord 频道，可领取免费体验资格</p>
 
-    create_user: Mapped[int] = mapped_column(sort_order=998, comment='创建者')
-    update_user: Mapped[int | None] = mapped_column(init=False, default=None, sort_order=998, comment='修改者')
-```
+<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
 
-通常情况下，你会在自定义模型类中继承 `Base` 父类，要想灵活的应用操作人员信息，你只需在继承 `Base` 父类的同时，也继承
-`UserMixin` 类，这样就将自动添加操作人员列到模型
-
-## 如何使用？
-
-应用操作人员信息后，首先，你要在接口参数中，传递 `request: Request`，并作为第一个参数（在 Django，flask 等框架中，这可能很常见）
-
-然后，在执行创建或更新操作时，可通过 `request.user.id` 直接获取操作人员 id，并进行数据库写入
-
-我们之所以没有默认应用此功能，是因为我们不想所有接口重复调用 `request` 参数（作者强迫症）
+</div>

docs/guide/reference/RBAC.md

@@ -14,6 +14,7 @@ RBAC 提供了两种解决方案，第一种【角色菜单】可能更加常见
 要想实现此 RBAC 调用，涉及到三处相关配置
 
 ::: steps
+
 1. 更新 RBAC 鉴权配置
 
    在 `core/conf.py` 文件中找到以下配置，并更新 `PERMISSION_MODE` 为 `role-menu`
@@ -25,7 +26,7 @@ RBAC 提供了两种解决方案，第一种【角色菜单】可能更加常见
 
 2. 添加接口依赖
 
-   只有在接口中参加此依赖时，才能自动应用此鉴权
+   只有在接口中填加此依赖时，才能自动应用此鉴权方式
 
     ```py{5-6}
     @router.post(
@@ -40,8 +41,8 @@ RBAC 提供了两种解决方案，第一种【角色菜单】可能更加常见
 
 3. 在菜单中添加权限标识
 
-   我们在接口依赖中可以看到 `sys:api:add` 之类的值，这些值正是对应着菜单中的权限标识，只有它们完全一致，并且用户拥有菜单时，才有权执行操作
-:::
+   我们在接口依赖中可以看到 `sys:api:add` 之类的值，这些值正是对应着菜单中的权限标识，只有它们完全一致，并且用户拥有菜单时，才会获得相应的操作权限
+   :::
 
 ### Casbin
 
@@ -77,15 +78,15 @@ m = g(r.sub, p.sub) && (keyMatch(r.obj, p.obj) || keyMatch3(r.obj, p.obj)) && (r
 p 策略：
 
 - 推荐添加基于角色的访问权限, 需配合添加 g 策略才能真正拥有访问权限，适合配置全局接口访问策略<br>
-**格式**: 角色 role + 访问路径 path + 访问方法 method
+  **格式**: 角色 role + 访问路径 path + 访问方法 method
 
 - 如果添加基于用户的访问权限, 不需配合添加 g 策略就能真正拥有权限，适合配置指定用户接口访问策略<br>
-**格式**: 用户 uuid + 访问路径 path + 访问方法 method
+  **格式**: 用户 uuid + 访问路径 path + 访问方法 method
 
 g 策略 (**依赖 p 策略**)：
 
 - 如果在 p 策略中添加了基于角色的访问权限, 则还需要在 g 策略中添加基于用户组的访问权限, 才能真正拥有访问权限<br>
-**格式**: 用户 uuid + 角色 role
+  **格式**: 用户 uuid + 角色 role
 
 - 如果在 p 策略中添加了基于用户的访问权限, 则不添加相应的 g 策略能直接拥有访问权限<br>
-但是拥有的不是用户角色的所有权限, 而只是单一的对应的 p 策略所添加的访问权限
+  但是拥有的不是用户角色的所有权限, 而只是单一的对应的 p 策略所添加的访问权限

docs/guide/reference/code-generation.md

@@ -8,7 +8,8 @@ title: 代码生成
 > 代码生成器使用 api 调用实现，包含两个模组，设计可能存在缺陷，相关问题请直接提交 issues
 
 > [!WARNING]
-> 由于 jinja2 在渲染模版时，文本方式输出可能存在格式问题，所以 `preview` 接口可能无法直观预览代码，这是为前端进行的预设
+> 由于 jinja2 在渲染模版时，文本方式输出可能存在格式问题，所以 `preview` 接口可能无法直观预览代码，这是为前端进行的预设，
+> 你可以在我们的在线预览中更加直观的查看生成效果
 
 ## 概念
 
@@ -20,13 +21,7 @@ title: 代码生成
 
 包含代码生成所需要的模型列信息，就像正常定义模型列一样，目前支持的功能有限
 
-## 使（食）用
-
-1. 启动后端服务，打开 swagger 文档直接操作
-2. 通过第三方 api 调试工具发送接口请求
-3. 同时启动前后端，从页面进行操作
-
-接口参数基本都有说明，请注意查看
+## 使用
 
 ### F. 纯手动模式
 

docs/guide/reference/cors.md

@@ -2,12 +2,11 @@
 title: 跨域
 ---
 
-当进行前后端项目联调或服务器部署时，你通常会遇到跨域问题，不过没关系，你只需修改后端配置，就可以轻松解决 CORS 相关问题
+当进行前后端项目联调或服务器部署时，你通常会遇到跨域问题，不过没关系，你只需进入 `core/conf.py` 文件，修改
+`CORS_ALLOWED_ORIGINS` 配置即可，就可以轻松解决 CORS 相关问题
 
 ## 本地
 
-进入 `core/conf.py` 文件，修改 `CORS_ALLOWED_ORIGINS` 配置即可
-
 ```py
 CORS_ALLOWED_ORIGINS: list[str] = [
         'http://localhost:5173',  # 前端访问地址，末尾不要带 '/'
@@ -16,8 +15,6 @@ CORS_ALLOWED_ORIGINS: list[str] = [
 
 ## 服务器
 
-进入 `core/conf.py` 文件，修改 `CORS_ALLOWED_ORIGINS` 配置即可
-
 1. 非 https 部署
 
     ```py

docs/guide/reference/oauth.md

@@ -2,19 +2,18 @@
 title: 授权
 ---
 
-::: note
+::: tip
 通过 JWT 中间件实现全局自动授权
 :::
 
-我们编写了自定义的 JWT 授权中间件，使其可以在每次请求发起时，自动调用此中间件实现自动授权，并且，通过 Redis 和 Rust 库对用户信息进行快速缓存，
-使其性能影响尽可能降到最低
+我们编写了自定义的 JWT 授权中间件，使其可以在每次请求发起时，自动调用此中间件实现自动授权，并且，通过 Redis 和 Rust
+库对用户信息进行快速缓存，使其性能影响尽可能降到最低，你可以通过以下几种方式进行自动授权
 
 ## 验证码登录
 
-我们提供了数字验证码方式的登录授权接口，登录成功后，JWT 将包含在接口响应信息中
+这种方式更适用于前端界面调用
 
-
-## Swagger 授权
+## Swagger 登录
 
 这是一种快捷的授权方式，但仅出于调试目的，在服务启动后，进入 Swagger UI，可通过此调试接口进行快速登录授权（无需验证码）
 

docs/guide/reference/transaction.md

@@ -2,8 +2,6 @@
 title: 事务
 ---
 
-我们可以通过两种方式实现数据库事务
-
 ## session 生成器
 
 这是官方一种比较流行的方法，通过迭代 session 控制隔离，并通过上下文异常进行回滚，最后关闭 session

docs/guide/summary/fsm.md

@@ -2,14 +2,15 @@
 title: 精简版本
 ---
 
-我们有一些简化版本的 fastapi 三层架构脚手架，但是它们的更新可能并不同步，这意味着，你可能无法及时在便捷版中获得新功能支持和的问题修复
+我们有一些简化版本的 fastapi 三层架构脚手架，==但是它们的更新可能并不同步==，这意味着，你可能无法及时在便捷版中获得新功能支持和问题修复
 
-::: info
+::: tip
 我们积极寻找这些版本仓库的维护人员，如果你对此感兴趣，请直接在对应仓库创建 ISSUES
 :::
 
+<RepoCard repo="wu-clan/fastapi_sqlalchemy_mysql" />
+
 <CardGrid>
-  <RepoCard repo="fastapi-practices/fastapi_sqlalchemy_mysql" />
-  <RepoCard repo="fastapi-practices/fastapi_tortoise_mysql" />
-  <RepoCard repo="fastapi-practices/fastapi_sqlmodel_mysql" />
+  <RepoCard repo="wu-clan/fastapi_tortoise_mysql" />
+  <RepoCard repo="wu-clan/fastapi_sqlmodel_mysql" />
 </CardGrid>