Skip to content

Commit b562020

Browse files
committed
update docs
1 parent 9f37e65 commit b562020

File tree

19 files changed

+36
-36
lines changed

19 files changed

+36
-36
lines changed

docs/.vuepress/components/Footer.vue

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</div>
1010
<div class="social-links">
1111
<a
12-
href="https://github.com/fastapi-practices/fastapi_best_architecture"
12+
href="https://github.com/fastapi-practices/fastapi-best-architecture"
1313
target="_blank"
1414
class="social-link"
1515
>
@@ -94,7 +94,7 @@
9494
<div class="footer-bottom-left">
9595
<span>Copyright © 2023-{{ currentYear }} FastAPI Practices and
9696
<a
97-
href="https://github.com/fastapi-practices/fastapi_best_architecture/graphs/contributors"
97+
href="https://github.com/fastapi-practices/fastapi-best-architecture/graphs/contributors"
9898
target="_blank"
9999
rel="noopener noreferrer"
100100
class="footer-link"
@@ -105,7 +105,7 @@
105105
<span>
106106
Released under the
107107
<a
108-
href="https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE"
108+
href="https://github.com/fastapi-practices/fastapi-best-architecture/blob/master/LICENSE"
109109
target="_blank"
110110
rel="noopener noreferrer"
111111
class="footer-link"
@@ -140,14 +140,14 @@ const links = {
140140
{ name: "常见问题", href: "/fastapi_best_architecture_docs/questions" },
141141
{
142142
name: "更新记录",
143-
href: "https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/CHANGELOG.md"
143+
href: "https://github.com/fastapi-practices/fastapi-best-architecture/blob/master/CHANGELOG.md"
144144
},
145145
],
146146
community: [
147147
{ name: "技术栈", href: "/fastapi_best_architecture_docs/stack" },
148148
{ name: "交流群", href: "/fastapi_best_architecture_docs/group" },
149-
{ name: "Github 问题", href: "https://github.com/fastapi-practices/fastapi_best_architecture/issues" },
150-
{ name: "Github 讨论", href: "https://github.com/fastapi-practices/fastapi_best_architecture/discussions" },
149+
{ name: "Github 问题", href: "https://github.com/fastapi-practices/fastapi-best-architecture/issues" },
150+
{ name: "Github 讨论", href: "https://github.com/fastapi-practices/fastapi-best-architecture/discussions" },
151151
{ name: "想法和建议", href: "https://discord.gg/xp8M6nY4NA" },
152152
],
153153
resources: [

docs/.vuepress/components/PluginMarketplace.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
<script setup lang="ts">
110110
import { ref, computed, onMounted, reactive } from 'vue'
111111
112-
// Data sync from: https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/plugin/validator.py
112+
// Data sync from: https://github.com/fastapi-practices/fastapi-best-architecture/blob/master/backend/plugin/validator.py
113113
const TAG_LABELS: Record<string, string> = {
114114
ai: 'AI',
115115
mcp: 'MCP',

docs/.vuepress/navbar.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
4141
{
4242
text: '更新记录',
4343
icon: 'stash:last-updates-duotone',
44-
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/CHANGELOG.md'
44+
link: 'https://github.com/fastapi-practices/fastapi-best-architecture/blob/master/CHANGELOG.md'
4545
},
4646
{
4747
text: '参与贡献',
4848
icon: 'mdi:people-add',
49-
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#contributing'
49+
link: 'https://github.com/fastapi-practices/fastapi-best-architecture/tree/master/backend#contributing'
5050
},
5151
]
5252
},
@@ -121,12 +121,12 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
121121
{
122122
text: 'Github 问题',
123123
icon: 'codicon:issues',
124-
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/issues'
124+
link: 'https://github.com/fastapi-practices/fastapi-best-architecture/issues'
125125
},
126126
{
127127
text: 'Github 讨论',
128128
icon: 'mdi:discussion',
129-
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/discussions'
129+
link: 'https://github.com/fastapi-practices/fastapi-best-architecture/discussions'
130130
},
131131
{
132132
text: '想法和建议',

docs/.vuepress/theme.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ export const myTheme: Theme = plumeTheme({
3838
createTime: false,
3939
},
4040
social: [
41-
{ icon: 'github', link: 'https://github.com/fastapi-practices/fastapi_best_architecture' },
41+
{ icon: 'github', link: 'https://github.com/fastapi-practices/fastapi-best-architecture' },
4242
{
4343
icon: {
4444
svg: `<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path fill="currentColor" d="M11.984 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12a12 12 0 0 0 12-12A12 12 0 0 0 12 0zm6.09 5.333c.328 0 .593.266.592.593v1.482a.594.594 0 0 1-.593.592H9.777c-.982 0-1.778.796-1.778 1.778v5.63c0 .327.266.592.593.592h5.63c.982 0 1.778-.796 1.778-1.778v-.296a.593.593 0 0 0-.592-.593h-4.15a.59.59 0 0 1-.592-.592v-1.482a.593.593 0 0 1 .593-.592h6.815c.327 0 .593.265.593.592v3.408a4 4 0 0 1-4 4H5.926a.593.593 0 0 1-.593-.593V9.778a4.444 4.444 0 0 1 4.445-4.444h8.296Z"/></svg>`,
4545
name: 'gitee'
4646
},
47-
link: 'https://gitee.com/wu_clan/fastapi_best_architecture'
47+
link: 'https://gitee.com/wu_clan/fastapi-best-architecture'
4848
},
4949
],
5050
navbarSocialInclude: ['github', 'gitee'],

docs/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ config:
1919
link: /backend/summary/quick-start
2020
- theme: sponsor
2121
text: 在线体验 ->
22-
link: https://fastapi-practices.github.io/fba_offline/
22+
link: https://fastapi-practices.github.io/fba-offline/
2323
- theme: alt
2424
text: 伪三层架构?
2525
link: /backend/summary/intro#伪三层架构
@@ -28,7 +28,7 @@ config:
2828
link: /backend/summary/why
2929
- theme: alt
3030
text: DeepWiki 文档
31-
link: https://deepwiki.com/fastapi-practices/fastapi_best_architecture
31+
link: https://deepwiki.com/fastapi-practices/fastapi-best-architecture
3232
- type: SponsorHome
3333
- type: features
3434
features:
@@ -138,7 +138,7 @@ mode="carousel"
138138
:::
139139

140140
<div align="center">
141-
<a href="https://github.com/fastapi-practices/fastapi_best_architecture/graphs/contributors">
142-
<img src="https://contrib.rocks/image?repo=fastapi-practices/fastapi_best_architecture"/>
141+
<a href="https://github.com/fastapi-practices/fastapi-best-architecture/graphs/contributors">
142+
<img src="https://contrib.rocks/image?repo=fastapi-practices/fastapi-best-architecture"/>
143143
</a>
144144
</div>

docs/backend/reference/apscheduler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: APScheduler
33
---
44

55
我们在最初的框架实现中,使用的是 APScheduler,但后来我们迁移到了
6-
Celery,详情:[#225](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/225)
6+
Celery,详情:[#225](https://github.com/fastapi-practices/fastapi-best-architecture/discussions/225)
77

88
FastAPI + APScheduler 现已作为独立仓库发行,它的优势在于易用性、灵活性和实时动态任务,如果你没有繁重的任务需求,它将是一个不错的选择
99

docs/backend/reference/celery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ celery
99

1010
Celery 是一个基于 Python
1111
开发的分布式任务队列系统,它在处理繁重计算或复杂任务具备极好的优势,因为它不会和主线程应用共享进程,而是在一个独立的进程中运行,这意味着,这些任务将被异步处理,而不会占用主线程应用的资源,这可以大大提高主应用程序的响应速度和吞吐量;你可以在我们的项目中找到迁移到
12-
Celery 的相关讨论,请查看:[#225](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/225)
12+
Celery 的相关讨论,请查看:[#225](https://github.com/fastapi-practices/fastapi-best-architecture/discussions/225)
1313

1414
## Broker(消息代理/中间件)
1515

docs/backend/reference/limit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 节流
33
---
44

55
在现代 Web 开发中,API 限流(Rate
6-
Limiting)是保护后端服务、防止资源滥用、保证服务稳定性的重要机制,我们有一个关于路由器的历史讨论,如果你感兴趣,可以查看:[#70](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/70)
6+
Limiting)是保护后端服务、防止资源滥用、保证服务稳定性的重要机制,我们有一个关于路由器的历史讨论,如果你感兴趣,可以查看:[#70](https://github.com/fastapi-practices/fastapi-best-architecture/discussions/70)
77

88
## 处理流程
99

docs/backend/reference/router.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ fba 中的路由遵循 Restful API 规范
66

77
## 路由结构
88

9-
我们有一个关于路由器的历史讨论,如果你感兴趣,可以查看:[#4](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/4)
9+
我们有一个关于路由器的历史讨论,如果你感兴趣,可以查看:[#4](https://github.com/fastapi-practices/fastapi-best-architecture/discussions/4)
1010

1111
当前路由结构如下所示:
1212

docs/backend/summary/intro.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ mvc 架构作为常规设计模式,在 python web 中很常见,但是三层
1616

1717
如果您不喜欢这种模式,可以对其进行任意改造!
1818

19-
| 模块 | java | fastapi_best_architecture |
19+
| 模块 | java | fastapi-best-architecture |
2020
|------|----------------|---------------------------|
2121
| 视图 | controller | api |
2222
| 数据传输 | dto | schema |
@@ -98,15 +98,15 @@ mvc 架构作为常规设计模式,在 python web 中很常见,但是三层
9898

9999
## 贡献者
100100

101-
<a href="https://github.com/fastapi-practices/fastapi_best_architecture/graphs/contributors">
102-
<img src="https://contrib.rocks/image?repo=fastapi-practices/fastapi_best_architecture"/>
101+
<a href="https://github.com/fastapi-practices/fastapi-best-architecture/graphs/contributors">
102+
<img src="https://contrib.rocks/image?repo=fastapi-practices/fastapi-best-architecture"/>
103103
</a>
104104

105105
## 许可证
106106

107-
本项目由 [MIT](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/LICENSE) 许可证的条款进行许可
107+
本项目由 [MIT](https://github.com/fastapi-practices/fastapi-best-architecture/blob/master/LICENSE) 许可证的条款进行许可
108108

109-
[![Stargazers over time](https://starchart.cc/fastapi-practices/fastapi_best_architecture.svg?variant=adaptive)](https://starchart.cc/fastapi-practices/fastapi_best_architecture)
109+
[![Stargazers over time](https://starchart.cc/fastapi-practices/fastapi-best-architecture.svg?variant=adaptive)](https://starchart.cc/fastapi-practices/fastapi-best-architecture)
110110

111111
## 特别鸣谢
112112

0 commit comments

Comments
 (0)