update docs

Author: wu-clan

docs/.vuepress/bulletin.ts

@@ -1,9 +1,9 @@
-import {BulletinOptions} from "vuepress-theme-plume";
+import { BulletinOptions } from "vuepress-theme-plume";
 
 export const myBulletin: BulletinOptions = {
     enablePage: true,
     lifetime: 'session',
     contentType: 'markdown',
-    title: 'FasAPI 最佳架构',
-    content: '欢迎大家加入 Discord 社区闲聊，分享，提供建议，高频艾特，你们的活跃度是我更新的动力 🌹',
+    title: '通知/公告',
+    content: '插件系统已发布, 欢迎体验和共创 🤗',
 }

docs/.vuepress/client.ts

@@ -1,4 +1,4 @@
-import {defineClientConfig} from 'vuepress/client'
+import { defineClientConfig } from 'vuepress/client'
 import RepoCard from 'vuepress-theme-plume/features/RepoCard.vue'
 import Layout from './layouts/Layout.vue'
 
@@ -7,7 +7,7 @@ import Swiper from "./components/Swiper.vue";
 import SponsorPanel from "./components/SponsorPanel.vue";
 
 export default defineClientConfig({
-    enhance({app}) {
+    enhance({ app }) {
         app.component('RepoCard', RepoCard)
         app.component('Swiper', Swiper)
         app.component('SponsorPanel', SponsorPanel)

docs/.vuepress/data/sponsors.ts

@@ -1,4 +1,6 @@
-import {ref} from "vue";
+import { ref } from "vue";
+
+const sponsorUrl: string = window.location.origin + '/fastapi_best_architecture_docs/sponsors.html';
 
 export const goldSponsors = ref([
     {
@@ -10,13 +12,13 @@ export const goldSponsors = ref([
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     },
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     }
 ])
@@ -31,31 +33,31 @@ export const generalSponsors = ref([
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     },
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     },
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     },
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     },
     {
         link: '',
         text: '成为赞助商',
-        href: 'https://fastapi-practices.github.io/fastapi_best_architecture_docs/sponsors.html#%E5%B1%95%E4%BD%8D%E8%B5%9E%E5%8A%A9%E5%95%86',
+        href: sponsorUrl,
         alt: 'wu-clan',
     }
 ])

docs/.vuepress/styles/custom.css

@@ -1,12 +1,13 @@
 :root {
     /* 公告宽度 */
-    /*--vp-bulletin-width: 385px;*/
+    /*--vp-bulletin-width: 333px;*/
     /* 链接颜色、强调色 */
     --vp-c-brand-1: rgba(0, 148, 133, 1);
     /* 链接、按钮 hover 颜色 */
     --vp-c-brand-2: rgba(0, 148, 133, 1);
     /* 背景色、边框色 */
     --vp-c-brand-3: rgba(0, 148, 133, 1);
+
     /* 导航栏分组 */
     .vp-menu-group {
         .title {
@@ -22,6 +23,7 @@
     --vp-c-brand-2: rgba(0, 148, 133, 1);
     /* 背景色、边框色 */
     --vp-c-brand-3: rgba(0, 148, 133, 1);
+
     /* 导航栏分组 */
     .vp-menu-group {
         .title {
@@ -30,7 +32,10 @@
     }
 }
 
-
+/* 首页文字说明 */
+.hero-text {
+    margin: 24px 0 40px !important;
+}
 
 .vp-swiper .swiper-slide-img {
     /* 轮播图图片拉伸效果 */

docs/README.md

@@ -21,28 +21,28 @@ config:
     features:
       - title: 最新技术栈
         icon: 🚀
-        details: 基于 FastAPI、SQLAlchemy 2.0、Pydantic-v2、Celery、等最新技术栈
+        details: 基于 FastAPI、SQLAlchemy 2.0、Pydantic-v2、Celery 等技术栈
       - title: 自研架构
         icon: 🧠
-        details: 独特的「伪三层架构」，让所有开发者轻松驾驭
-      - title: 全局异步
-        icon: 🔄
-        details: 基于 async/await + asgiref 实现全局异步处理，告别协程阻塞问题
+        details: 独特的「伪三层架构」，让所有开发者可轻松驾驭
+      - title: 插件系统
+        icon: unjs:unplugin
+        details: 告别高耦合集成，让功能变得可轻松 Hot Swap（热插拔）
       - title: JWT
         icon: 🔏
-        details: 带有缓存和白名单的 JWT 中间件自动认证
-      - title: 权限管理
+        details: 带有缓存和白名单的 JWT 授权中间件
+      - title: RBAC
         icon: 🛠️
-        details: 提供 Casbin、Role-Menu 两种 RBAC 权限方案。开关控制选择
+        details: 提供 Casbin、Role-Menu 两种 RBAC 方案
       - title: 代码生成
         icon: ⚙️
-        details: 提供后端代码自动生成，告别繁琐基础代码结构 cv
+        details: 内置代码自动生成，告别通用代码频繁 cv
       - title: 时区时间
         icon: ⌛
-        details: 通过配置一键应用全局时区时间，告别时间处理烦恼
+        details: 提供全局时区时间配置，告别时间处理烦恼
       - title: 日志
         icon: 📝
-        details: 内置十分强大的日志系统，全方位 Trace ID 助你一步锁定问题
+        details: 强大的日志系统，Trace ID 助你轻松定位任何问题
       - title: Docker
         icon: 🐳
         details: 提供 Docker compose 一键部署方案

docs/backend/summary/intro.md

@@ -81,7 +81,7 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
   - middleware/ 中间件
   - plugin 插件
     - code_generator/ 代码生成
-    - ...
+    - …
   - scripts/ 脚本
   - sql/ SQL 文件
   - static/ 静态文件

docs/backend/summary/quick-start.md

@@ -182,12 +182,12 @@ fba 仅适用于资深 Python 后端开发人员，如果您是非资深用户
 ## 开发流程
 
 ::: tip
-仅供参考，实际以个人习惯为准
+仅供参考，实际以个人开发习惯为准
 :::
 
 ::: steps
 
-1. 定义数据库模型（model）
+1. 定义数据库模型（[model](../reference/model.md)）
 
 2. 定义数据验证模型（[schema](../reference/schema.md)）
 

docs/plugin/dev.md

@@ -100,7 +100,7 @@ tags = ''
       - utils/ 工具包 <Badge type="warning" text="非必须" />
       - \_\_init\_\_.py 作为 python 包保留 <Badge type="danger" text="必须" />
       - conf.py 插件独立配置 <Badge type="warning" text="非必须" />
-      - ... 更多其他配置，例如 enums.py... <Badge type="warning" text="非必须" />
+      - … 更多其他配置，例如 enums.py... <Badge type="warning" text="非必须" />
       - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
       - README.md 插件使用说明 <Badge type="danger" text="必须" />
       - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />；