Skip to content

Commit 49e8b78

Browse files
committed
update docs
1 parent 47f62ce commit 49e8b78

File tree

4 files changed

+30
-5
lines changed

4 files changed

+30
-5
lines changed

docs/.vuepress/navbar.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ export const myNavbar = defineNavbarConfig([
1616
{
1717
text: '贡献',
1818
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#readme'
19+
},
20+
{
21+
text: '更新记录',
22+
link: ''
1923
}
2024
]
2125
},
@@ -24,6 +28,11 @@ export const myNavbar = defineNavbarConfig([
2428
icon: 'fluent-emoji-high-contrast:unicorn',
2529
link: 'https://github.com/fastapi-practices/fastapi_best_architecture/issues'
2630
},
31+
{
32+
text: '授权',
33+
icon: 'ri:key-2-fill',
34+
link: '/guide/summary/why.md#承诺'
35+
},
2736
{
2837
text: '赞助',
2938
icon: 'ci:coffee',

docs/.vuepress/sidebar.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ export const mySidebar: SidebarMulti = {
4141
{text: 'Docker', link: 'Docker'},
4242
{text: '传统', link: 'legacy'},
4343
]
44+
},
45+
{
46+
text: '其他',
47+
collapsed: false,
48+
prefix: 'other/',
49+
items: [
50+
{text: '更新记录', link: 'changelog'},
51+
]
4452
}
4553
],
4654
}

docs/guide/other/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: 更新日志
3+
---
4+
5+
<h5>我们目前仍处于开发阶段,暂不提供此记录</h5>

docs/guide/summary/why.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ title: 为什么选择我们?
1515
## 承诺
1616

1717
<div style="text-align: center">
18-
<h3>「永久 MIT 协议」「永久免费」「永久免授权」</h3>
19-
<p>无任何强制收费行为,我们唯一的收入来源仅为赞助,它们将全部用于基础设施建设(服务器,域名...)</p>
18+
<h3>「永久 MIT 协议」「永久免授权」</h3>
19+
<p>只需一个 GitHub star,无任何强制收费行为,我们唯一的收入来源仅为<a href="https://wu-clan.github.io/sponsor/">赞助</a></p>
20+
<p style="float: right">--- <a href="https://github.com/fastapi-practices">fastapi-practices</a> 对此拥有所有解释权</p>
21+
<br>
2022
</div>
2123

2224
## 架构
@@ -25,11 +27,12 @@ title: 为什么选择我们?
2527

2628
## 框架历程
2729

28-
TODO
30+
建设中...
2931

3032
## 质量与规范
3133

32-
- 高可用代码注解
33-
- 严格遵守[自定义 ruff 规则](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/.ruff.toml)
34+
- 真正有用的代码注解
3435
- 全局使用 reStructuredText 文档风格
36+
- 快速同步框架新特性
37+
- 编码严格遵守[自定义 ruff 规则](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/.ruff.toml)
3538
- GitHub CI 代码规范检测

0 commit comments

Comments
 (0)