Skip to content

Commit f02dfce

Browse files
Deploy to GitHub pages
0 parents  commit f02dfce

359 files changed

Lines changed: 14007 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404.html

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

ai/llms.html

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

ai/llms.md

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

ai/mcp.html

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

ai/mcp.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
url: /fastapi_best_architecture_docs/ai/mcp.md
3+
---
4+
[MCP 介绍](../blog/claude-ai-ecosystem.md){.read-more}
5+
6+
## ace (Augment Context Engine)
7+
8+
官网:[ace](https://www.augmentcode.com/context-engine)
9+
10+
相关文章:[linuxdo#1360514](https://linux.do/t/topic/1360514)
11+
12+
首当其冲的绝对是它,ace 绝对是无与伦比的存在,检索快,定位准;
13+
14+
但其存在国内账号注册难,订阅开通难,费用昂贵,易封号等多重机制,只能说是且用且珍惜
15+
16+
## fetch
17+
18+
源码:[fetch](https://github.com/modelcontextprotocol/servers/tree/main/src/fetch)
19+
20+
MCP 官方实现,使 LLM 能够从网页中检索和处理内容,并将 HTML 转换为 Markdown 以便于阅读和使用,虽然目前很多 LLM 已经内置 web
21+
搜索引擎,但 fetch 仍可作为本级支持的一部分(免费)
22+
23+
## playwright
24+
25+
源码:[playwright-mcp](https://github.com/microsoft/playwright-mcp)
26+
27+
Playwright 是由微软(Microsoft)在 2020 年初开源的现代化 Web 测试与自动化框架,而 playwright-mcp 能够使 LLM
28+
通过结构化的可访问性快照与网页进行交互,从而无需依赖屏幕截图或视觉调整后的模型

ai/prompt.html

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

ai/prompt.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
url: /fastapi_best_architecture_docs/ai/prompt.md
3+
---
4+
提示词不以多取胜,而是可用性,无效的提示词反而会给 LLM 带来负担
5+
6+
[Prompt 介绍](../blog/claude-ai-ecosystem.md){.read-more}
7+
8+
## 语言规范
9+
10+
```markdown
11+
## Language norms
12+
13+
Thinking and executing are always in English, but replies are always in Chinese.
14+
```
15+
16+
## 文件写入
17+
18+
```markdown
19+
## File write
20+
21+
When writing too much file content at one time, always write in batches.
22+
```

ai/skills.html

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

ai/skills.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
url: /fastapi_best_architecture_docs/ai/skills.md
3+
---
4+
[Skills 介绍](../blog/claude-ai-ecosystem.md){.read-more}
5+
6+
## fba
7+
8+
[fba skill](https://skills.sh/fastapi-practices/skills/fba) 提供完整的架构规范、编码风格、插件开发指导
9+
10+
## antdv-next
11+
12+
[antdv-next skill](https://skills.sh/antdv-next/skills/antdv-next) Antdv Next Vue 3 组件库技能
13+
14+
## writing-plans
15+
16+
[writing-plans skill](https://skills.sh/obra/superpowers/writing-plans) 编写全面的实施计划
17+
18+
## executing-plans
19+
20+
[executing-plans skill](https://skills.sh/obra/superpowers/executing-plans) 制定计划,严格审查,分批执行任务,并在批次之间提交审查报告
21+
22+
## drawio
23+
24+
[drawio](https://skills.sh/bahayonghang/drawio-skills/drawio) 使用 Draw.io XML 和 Design System 2.0 创建、编辑和导出架构图、流程图和技术图
25+
26+
## excalidraw-diagram
27+
28+
[excalidraw-diagram skill]() 根据语言描述生成 Excalidraw 格式的图表

architecture.html

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)