Skip to content

Commit bde7c13

Browse files
committed
update docs
1 parent b00424a commit bde7c13

File tree

9 files changed

+688
-17
lines changed

9 files changed

+688
-17
lines changed

docs/changelog.md

Lines changed: 654 additions & 0 deletions
Large diffs are not rendered by default.

docs/guide/reference/db.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ DATABASE_PASSWORD='123456'
3434
PostgreSQL,例如:
3535

3636
```python:no-line-numbers
37-
# [!code word:with_variant]
38-
remark: Mapped[str | None] = mapped_column(LONGTEXT().with_variant(TEXT, 'postgresql'))
37+
remark: Mapped[str | None] = mapped_column(LONGTEXT().with_variant(TEXT, 'postgresql')) # [!code word:with_variant]
3938
```
4039

4140
- 删除 `with_variant` 相关代码并且仅保留数据库对应的类型

docs/guide/reference/pagination.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
title: 分页
33
---
44

5-
coming soon...
5+
需等待 PR
6+
合并:[Allow to have multiple Query parameter models](https://github.com/fastapi/fastapi/pull/12944#pullrequestreview-2588580175)

docs/guide/summary/fsm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ FastAPI 三层架构脚手架精简版的更新可能并不同步,你可能无
1717

1818
## Tortoise-ORM
1919

20-
==不太推荐== 如果您正在使用 Tortoise-ORM(或您是一位 Django 资深用户,并深爱 Django-ORM),请使用以下版本,但此版本缺少维护人员
20+
==不太推荐=={.note} 如果您正在使用 Tortoise-ORM(或您是一位 Django 资深用户,并深爱 Django-ORM),请使用以下版本,但此版本缺少维护人员
2121

2222
<RepoCard repo="fastapi-practices/fastapi_tortoise_mysql" />
2323

2424
## SQLModel
2525

26-
==不推荐== SQLModel 是 FastAPI 作者创建的 ORM 框架,整合了 SQLAlchemy 和 Pydantic,如果您喜欢强耦合开发,请使用以下版本,但此版本基本没有维护
26+
==不推荐=={.warning} SQLModel 是 FastAPI 作者创建的 ORM 框架,整合了 SQLAlchemy 和 Pydantic,如果您喜欢强耦合开发,请使用以下版本,但此版本基本没有维护
2727

2828
<RepoCard repo="fastapi-practices/fastapi_sqlmodel_mysql" />

docs/guide/summary/why.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
2929

3030
## 开放性
3131

32-
- MIT 协议 + 架构源码全开源
33-
- 模板仓库,便捷复制和自主命名
34-
- 架构内没有任何以 `fba` 强制命名的内容,也就是说,你可以通过 IDE 快捷替换所有 `fba` 参数为其他
32+
- MIT 协议 + 架构源码全量开源
33+
- GitHub 模板仓库,便捷复制和自主命名
34+
- 架构内没有任何以 `fba` 强制命名的内容,也就是说,你可以通过 IDE 快捷替换所有 `fba` 参数为自定义
3535

3636
## 长期维护
3737

docs/planet.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,17 @@ title: 知识星球
1616
</div>
1717
:::
1818

19-
## 教程
19+
## 文章
2020

2121
- <Icon name="fluent-color:receipt-16" /> 纯文字文章
2222
- <Icon name="fluent-color:video-16" /> 带有视频讲解的文章
2323

2424
### fba 专属
2525

26+
::: note
27+
此分类下的文章主要应用于 fba 架构,可能无法应用于其他三方架构方案
28+
:::
29+
2630
<CardGrid>
2731
<LinkCard
2832
title="操作人信息"
@@ -64,6 +68,10 @@ title: 知识星球
6468

6569
### FastAPI 通用
6670

71+
::: note
72+
此分类下的文章可应用于任何基于 FastAPI 框架开发的架构
73+
:::
74+
6775
<CardGrid>
6876
<LinkCard
6977
title="Socketio"
@@ -83,13 +91,21 @@ title: 知识星球
8391

8492
<CardGrid>
8593
<LinkCard
86-
title="日志分析"
94+
title=""
8795
icon="fluent-color:receipt-16"
88-
href="/planet"
89-
description="即将到来..."
96+
description="..."
9097
/>
9198
</CardGrid>
9299

93100
## 插件
94101

95-
即将到来...
102+
::: note
103+
此分类下的插件仅可应用于 fba 架构的 [插件系统](./plugin/market.md)
104+
:::
105+
106+
<CardGrid>
107+
<LinkCard
108+
title="空"
109+
description="..."
110+
/>
111+
</CardGrid>

docs/plugin/market.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ title: 插件市场
6262

6363
## 安装
6464

65-
插件安装方式大致可分为两种
65+
插件安装方式可分为两种
6666

6767
### 手动
6868

docs/sponsors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ fba 是一款基于 FastAPI 框架的后端架构解决方案,遵循伪三层
2121
您可以加入我们创建的 [知识星球](https://t.zsxq.com/PDk8b),获取星球内提供的独家内容,另外,我们会为您添加 Discord
2222
身份标签,以便将您加入专属频道,针对标签用户,我们还可以提供一对一线上指导,远程支持等...
2323

24-
请注意,我们不保证星球内容的更新频率,您可以==依据星球规则进行全额退款==,我们鼓励大家[参与贡献](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#readme)
24+
请注意,我们不保证星球内容的更新频率,==您可以依据星球规则进行全额退款==,我们鼓励大家[参与贡献](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#readme)
2525
,如果您能为 Issues 提供 PR,并且被审核通过,我们将向您发送大额优惠券或免费邀请(基于 PR 质量)
2626

2727
## 展位赞助商

docs/who.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ title: 谁在使用?
44

55
> [!IMPORTANT]
66
> 如果您/您所在的企业/组织使用了 fba
7-
> 进行项目开发,我们诚挚的邀请您参与:[用户登记](https://github.com/fastapi-practices/fastapi_best_architecture/issues/477)
7+
>
8+
进行项目开发,我们诚挚的邀请您参与:[用户登记](https://github.com/fastapi-practices/fastapi_best_architecture/issues/477)
89
>
910
> 1. **无偿登记**:您的登记完全免费,我们郑重承诺,并且绝对不会在任何阶段向您收取任何形式的使用费用,也不会将您的信息用于商业盈利或其他非公开目的
1011
> 2. **优先支持**:登记后,您将被视为我们的优质用户,我们的维护团队将优先响应您在实际使用过程中遇到的问题
@@ -19,7 +20,7 @@ title: 谁在使用?
1920
<ImageCard
2021
image="https://wu-clan.github.io/picx-images-hosting/fba.png"
2122
title="fba"
22-
description="基于 FastAPI 框架的后端架构解决方案,遵循伪三层架构设计, 支持 Python 3.10 及以上版本"
23+
description="基于 FastAPI 框架的企业级后端架构解决方案,遵循伪三层架构设计, 支持 Python 3.10 及以上版本"
2324
href="https://fastapi-practices.github.io/fastapi_best_architecture_docs/"
2425
/>
2526
</CardGrid>

0 commit comments

Comments
 (0)