Skip to content

Commit 6a41a54

Browse files
committed
update docs
1 parent 039ff96 commit 6a41a54

File tree

10 files changed

+22
-20
lines changed

10 files changed

+22
-20
lines changed

docs/.vuepress/navbar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ export const myNavbar = defineNavbarConfig([
8080
},
8181
{
8282
text: '插件市场',
83-
icon: 'clarity:plugin-solid',
83+
icon: 'unjs:unplugin',
8484
link: '/plugin/before'
8585
},
8686
{
87-
text: '授权',
87+
text: '购买授权',
8888
icon: 'fluent:person-key-20-filled',
8989
link: '/backend/summary/why.md#承诺'
9090
},

docs/backend/reference/response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def test() -> ResponseSchemaModel[GetApiDetail]:
7575
我们可以看到,响应 Schema 中的 data 已经包含我们的响应体结构了,响应体结构正是解析的 `[]` 中的 Schema 模型,它们是对应的,如果返回的数据结构与
7676
Schema 不一致,将引发解析错误
7777

78-
==我们建议将这种方式仅用于查询接口=={.note},如果你不需要这种文档,你完全可以不使用它,而是使用更加开放的统一响应模型
78+
我们建议将这种方式仅用于查询接口,如果你不需要这种文档,你完全可以不使用它,而是使用更加开放的统一响应模型
7979
ResponseModel
8080

8181
## 统一返回方法

docs/backend/summary/quick-start.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,9 @@ title: 快速开始
33
---
44

55
::: caution
6-
==fba 仅适用于资深 Python 后端开发人员=={.warning},如果您是非资深用户,建议使用 [精简版](../summary/fsm.md)
6+
fba 仅适用于资深 Python 后端开发人员,如果您是非资深用户,我们建议您从 [精简版](../summary/fsm.md) 开始学习
77
:::
88

9-
> [!IMPORTANT]
10-
> 我们建议新手用户从基础且简单的部分开始学习,这不仅是对自己学习负责的表现,也为未来顺利掌握这一架构奠定了坚实基础。欢迎加入我们的
11-
> Discord 社区,一起交流讨论!
12-
>
13-
> 最后,请务必认真阅读本文档,并严格按照文档的顺序启动项目,否则在启动过程中很可能会遇到各种问题。
14-
159
## 本地开发
1610

1711
::: tip
@@ -142,7 +136,7 @@ title: 快速开始
142136

143137
9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选" />
144138

145-
`backend` 目录打开终端,执行以下创建启动 celery 相关服务
139+
`backend` 目录打开终端,执行以下命令启动 celery 相关服务
146140

147141
::: code-tabs
148142
@tab Worker

docs/backend/summary/why.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
1212
::: note
1313
我们不会去对比任何其他架构,我们认为每个架构都有自己的特点,适用于不同的场景。
1414

15-
fba 绝对是开源架构中==代码最干净,最规范且最令人赏心悦目的项目之一=={.note}
15+
==fba 绝对是开源架构中代码最干净,最规范且最令人赏心悦目的项目之一=={.note}
1616
:::
1717

1818
## 目标

docs/frontend/arco.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ title: Arco Design Pro 实验性实施
1111

1212
::: caution
1313
「Arco Design Pro 实验性实施」自 fba [v1.0.4](https://github.com/fastapi-practices/fastapi_best_architecture/releases/tag/v1.0.4)
14-
版本起,正式宣告其使命完结
14+
版本起,正式宣告其使命完结,fba 后续版本将不再对此进行适配!
1515
:::

docs/frontend/intro.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@ title: 介绍
33
---
44

55
基于 Vben Admin Antd 构建的 fastapi_best_architecture 前端完整版实施
6+
7+
::: warning
8+
此版本目前正在开发中...
9+
:::

docs/frontend/quick-start.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,4 @@
22
title: 快速开始
33
---
44

5-
奋力开发中...
6-
7-
::: warning
8-
抢先拉取代码进行体验的用户,请同步拉取最新 fba 代码并清理 redis 缓存
9-
:::
5+
抢先进行体验的用户,请自行拉取最新前后端代码并清理 redis 缓存

docs/plugin/dev.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ title: 插件开发
3939
- service/ 服务 <Badge type="warning" text="非必须" />
4040
- utils/ 工具包 <Badge type="warning" text="非必须" />
4141
- \_\_init__.py 作为 python 包保留 <Badge type="danger" text="必须" />
42+
- ...
4243
- conf.py 常量配置 <Badge type="warning" text="非必须" />
4344
- plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
4445
- README.md 插件使用说明 <Badge type="danger" text="必须" />

docs/plugin/market.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ title: 插件市场
2222

2323
这些插件由 fba 内置
2424

25-
2625
<CardGrid>
2726
<Card icon="fe:notice-active" title="通知公告">
2827
<p style="color: #898989;">发布系统内部通知、公告</p>
@@ -71,6 +70,14 @@ title: 插件市场
7170
<Badge text="extra" color="#11aa00"/>
7271
</span>
7372
</LinkCard>
73+
<LinkCard icon="streamline:ai-prompt-spark" title="MCP ChatGPT" href="https://github.com/fastapi-practices/fba_mcp">
74+
<p style="color: #898989;">可调用 MCP 服务器的增强版 AI 聊天</p>
75+
<span>
76+
<Badge type="info" text="free" />
77+
<Badge type="tip" text="fba" />
78+
<Badge text="extra" color="#11aa00"/>
79+
</span>
80+
</LinkCard>
7481
</CardGrid>
7582

7683
## 第三方

docs/who.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: 谁在使用?
1010
> 2. **优先支持**:登记后,您将被视为我们的优质用户,我们的维护团队将优先响应您在实际使用过程中遇到的问题
1111
> 3. **官方认可**:您会在我们的官方网站上获得集中展示,让更多人有机会了解您的公司或项目
1212
>
13-
> 在进行用户调研时,一个常见且关键的问题是:==此项目有人应用在生产环境中吗?=={.note}
13+
> 在进行用户调研时,一个常见且关键的问题是:==这个项目有人在生产环境中使用吗?=={.note}
1414
> 面对这样的询问,仅仅依赖口头回答往往显得苍白无力,而使用登记数据则更为直观且有力,至此,我们再次非常诚挚的邀请您参与用户登记
1515
1616
## 公司 / 组织

0 commit comments

Comments
 (0)