update docs

Author: wu-clan

docs/.vuepress/sidebar.ts

@@ -67,7 +67,6 @@ export const mySidebar: ThemeSidebarMulti = {
             collapsed: false,
             items: [
                 { text: '前言', link: 'before' },
-                { text: '快速开始', link: 'install' },
             ]
         },
         {
@@ -78,6 +77,13 @@ export const mySidebar: ThemeSidebarMulti = {
                 { text: '插件发布', link: 'publish' },
             ]
         },
+        {
+            text: '使用',
+            collapsed: false,
+            items: [
+                { text: '插件安装', link: 'install' }
+            ]
+        },
         {
             text: '市场',
             collapsed: false,

docs/.vuepress/styles/custom.css

@@ -9,7 +9,6 @@
     --vp-c-brand-3: rgba(0, 148, 133, 1);
 
     /* 导航栏分组 */
-
     .vp-menu-group {
         .title {
             color: rgba(60, 60, 60, 0.33);
@@ -26,7 +25,6 @@
     --vp-c-brand-3: rgba(0, 148, 133, 1);
 
     /* 导航栏分组 */
-
     .vp-menu-group {
         .title {
             color: rgba(235, 235, 235, 0.38);

docs/README.md

@@ -79,3 +79,12 @@ mode="carousel"
 :space-between="10"
 :speed="5000"
 />
+
+<h2 align="center" style="border-top: none; margin-bottom: 24px">贡献者</h2>
+
+<div align="center">
+  <a href="https://github.com/fastapi-practices/fastapi_best_architecture/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=fastapi-practices/fastapi_best_architecture"/>
+  </a><br>
+  <a href="/fastapi_best_architecture_docs/join.html" style="font-size: 13px">加入我们</a>
+</div>

docs/backend/reference/RBAC.md

@@ -4,8 +4,8 @@ title: RBAC
 
 我们通过自定义依赖组件，实现了 RBAC 的轻松集成，它可以通过 FastAPI Depends 轻松集成
 
-::: warning
-自 fba `v1.1.2` 版本起，开始使用【角色菜单】作为默认 RBAC 鉴权，Casbin 将作为外置插件进行分发
+::: caution
+自 fba [v1.2.0](../../changelog.md) 版本起，开始将【角色菜单】作为默认 RBAC 鉴权，Casbin 作为外置插件进行分发
 :::
 
 ## 角色菜单
@@ -37,8 +37,19 @@ title: RBAC
 
 ## Casbin
 
-此方案是 Go 语言中比较流行的解决方案，它非常灵活，可以通过模型定义多种控制规则，要想实现此 RBAC
-鉴权，请通过 [插件市场](../../plugin/market.md) 获取
+此方案是 Go 语言中比较流行的解决方案，它非常灵活，可以通过模型定义多种控制规则
+
+要想实现此 RBAC 鉴权，请先 [获取插件](../../plugin/market.md)，然后执行以下操作
+
+::: steps
+
+1. 安装插件
+
+2. 启用鉴权
+
+   修改 `backend/core/conf.py` 文件中的 `RBAC_ROLE_MENU_MODE` 为 `False`
+
+:::
 
 ## 解耦
 

docs/backend/reference/router.md

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

docs/backend/summary/intro.md

@@ -66,7 +66,7 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
             - api/ 接口
             - crud/ CRUD
             - model 模型
-                - \_\_init\_\_.py 必须在此文件内导入所有模型类
+                - __init__.py 必须在此文件内导入所有模型类
                 - …
             - schema/ 数据传输
             - service/ 服务

docs/plugin/dev.md

@@ -99,13 +99,13 @@ fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对
         - xxx 插件名 <Badge type="danger" text="必须" />
             - api/ 接口 <Badge type="danger" text="必须" />
             - crud/ CRUD <Badge type="warning" text="非必须" />
-            - model/ 模型 <Badge type="warning" text="非必须" />
-                - \_\_init\_\_.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
+            - model 模型 <Badge type="warning" text="非必须" />
+                - __init__.py 在此文件内导入所有模型类 <Badge type="danger" text="必须" />
                 - …
             - schema/ 数据传输 <Badge type="warning" text="非必须" />
             - service/ 服务 <Badge type="warning" text="非必须" />
             - utils/ 工具包 <Badge type="warning" text="非必须" />
-            - \_\_init\_\_.py 作为 python 包保留 <Badge type="danger" text="必须" />
+            - __init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
             - conf.py 插件独立配置 <Badge type="warning" text="非必须" />
             - … 更多其他配置，例如 enums.py... <Badge type="warning" text="非必须" />
             - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />