Skip to content

Commit 7b7d3d9

Browse files
committed
update docs
1 parent d8af39d commit 7b7d3d9

File tree

5 files changed

+49
-8
lines changed

5 files changed

+49
-8
lines changed

docs/.vuepress/data/sponsors.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ export const goldSponsors: Sponsor[] = [
2424
alt: 'Bywave',
2525
expiryTime: '2099-12-31T23:59:59',
2626
},
27-
{
28-
link: 'https://www.serpshot.com/logo.png',
29-
href: 'https://www.serpshot.com',
30-
alt: 'Serpshot',
31-
expiryTime: '2099-12-31T23:59:59',
32-
},
3327
{ ...defaultSponsor }
3428
]
3529

docs/.vuepress/navbar.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ export const myNavbar: ThemeNavItem[] = defineNavbarConfig([
7070
icon: 'streamline:ai-prompt-spark-remix',
7171
link: '/ai/prompt',
7272
},
73+
{
74+
text: 'llms.txt',
75+
icon: 'octicon:ai-model-16',
76+
link: '/ai/llms',
77+
},
7378
]
7479
},
7580
{

docs/.vuepress/sidebar.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ export const mySidebar: ThemeSidebarMulti = {
111111
{ text: 'Skills', link: 'skills' },
112112
{ text: 'MCP', link: 'mcp' },
113113
{ text: 'Prompt', link: 'prompt' },
114+
{ text: 'llms.txt', link: 'llms' },
114115
]
115116
},
116117
]

docs/ai/llms.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: LLMS.txt
3+
---
4+
5+
本指南介绍如何让 Cursor、Windsurf 和 Claude 等 AI 工具更好地理解 fba
6+
7+
## 什么是 llms.txt?
8+
9+
我们支持通过 llms.txt 文件向大语言模型(llms)提供 fba 文档。此功能可帮助 AI 工具更好地理解我们的组件库、API 及使用模式
10+
11+
## 可用资源
12+
13+
我们提供多个 llms.txt 路由来帮助 AI 工具访问文档:
14+
15+
- [llms.txt](https://docs.fba.wu-clan.cc/fastapi_best_architecture_docs/llms.txt) - 包含所有组件及其文档链接的结构化概览
16+
- [llms-full.txt](https://docs.fba.wu-clan.cc/fastapi_best_architecture_docs/llms-full.txt) - 提供包含实现细节和示例的完整文档
17+
18+
## 在 AI 工具中的使用
19+
20+
### Cursor
21+
22+
在 Cursor 中使用 @Docs 功能将 llms.txt 文件包含到您的项目中。这有助于 Cursor 为 fba 组件提供更准确的代码建议和文档
23+
24+
[详细了解 Cursor 中的 @Docs 功能](https://cursor.com/cn/docs/context/mentions#docs)
25+
26+
### Claude Code
27+
28+
在 Claude Code 中,将 llms.txt 添加到工作区的知识库(Docs / Context Files)配置中,即可在代码补全与解释时引用其中的内容,从而提升对
29+
fba 组件的理解
30+
31+
[详细了解 Claude Code 文档上下文配置](https://code.claude.com/docs)
32+
33+
### Gemini CLI
34+
35+
在 Gemini CLI 中,可以通过 --context 参数或在 .gemini/config.json 中指定 llms.txt 文件路径,让 Gemini 在回答和生成代码时参考该文档
36+
37+
[详细了解 Gemini CLI 上下文配置](https://ai.google.dev/gemini-api/docs?hl=zh-cn)
38+
39+
## 其他 AI 工具
40+
41+
任何支持 llms.txt 的 AI 工具均可使用以上路径来更好地理解 fba

docs/ai/skills.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Skills
33
---
44

5-
[fba skill](https://skills.sh/fastapi-practices/skills/fba) 提供完整的架构规范、编码风格、插件开发指导
6-
75
[Skills 介绍](../blog/claude-ai-ecosystem.md){.read-more}
86

7+
## fba
98

9+
[fba skill](https://skills.sh/fastapi-practices/skills/fba) 提供完整的架构规范、编码风格、插件开发指导

0 commit comments

Comments
 (0)