跳到主要内容
版本：3.1

LLMs.txt（AI 助手接入）

Aegis 文档站遵循 llmstxt.org 约定，为 AI 助手（大语言模型）提供纯 Markdown 的文档端点。本文说明可用资源与各 AI 工具的接入方法。

什么是 LLMs.txt​

llms.txt 是一个面向大语言模型的站点入口约定：站点根提供一份 Markdown 索引，AI 工具按索引按需抓取文档原文，无需解析带导航噪音的 HTML 页面。Aegis 文档站的索引与镜像随每次发布自动重建，永远与站内页面同源。

可用资源​

完整地址 = 站点域名 + 下表端点路径。生产站域名为 https://doc.dezhentech.com，开发站为 https://doc.dezhentech.com/doc-dev；例如开发站索引即 https://doc.dezhentech.com/doc-dev/llms.txt。

端点路径说明
/llms.txt导航索引，含全部使用手册与开发规范的链接及一句话描述
/llms-full.txt全部文档拼接的单文件（约 1MB，离线全量场景）
/md/<文档路径>.md单篇原文直链，路径与站内目录一致，如 /md/基础文档/Controller.md

说明：

  • 索引每条目附一句话描述与章节目录，AI（和人）不抓取原文即可判断相关性；「按任务找文档」分组为常见任务给出入口组合
  • 索引「版本」分组列出历史版本文档入口；patch 级差异以手册内的版本说明（如 FreeSql 版本锁定表）为准
  • 本页自身也有 Markdown 版本：/md/llms.md

在 AI 工具中使用​

各工具共用同一段提示词（开发站预览时把 https://doc.dezhentech.com 替换为 https://doc.dezhentech.com/doc-dev）：

阅读 https://doc.dezhentech.com/llms.txt 并理解 Aegis 框架的文档结构。在编写基于 Aegis 的代码前，按索引抓取涉及组件的使用手册，遵守框架的分层与数据访问约束。

工具接入方式
ZCode / Claude Code / CodexAGENTS.md（或 CLAUDE.md）
CursorProject Rules（.cursor/rules）或 @docs
GitHub Copilot.github/copilot-instructions.md
Windsurf.windsurf/rules 或 memories
Gemini CLI.gemini/config.json 或 --context
其他任何支持自定义指令或可抓取 URL 的助手，直接给上面的提示词即可

推荐把提示词写进 AGENTS.md——它正在成为跨工具的通用标准，主流工具已直接支持。

业务项目接入模板​

以下模板使用生产站地址（业务项目长期应指向生产站）；在开发站验证时把 https://doc.dezhentech.com 替换为 https://doc.dezhentech.com/doc-dev。

## Aegis 框架文档

- 本项目 Aegis 大版本：<如 3.1，以 csproj / Directory.Packages.props 中 Aegis 包版本为准>
- 框架文档索引：https://doc.dezhentech.com/llms.txt（索引头部标有对应版本，与本项目不符时改用其「版本」分组入口）
- 使用任何 Aegis 组件前，先按索引抓取对应组件的 /md/ 手册再动手
- 遵守框架的分层与数据访问约束（Controller / Services / Repository / Dto 分层见索引「基础文档」分组）
- 离线全量：https://doc.dezhentech.com/llms-full.txt（大文件，仅按需检索）

注意事项​

  • 端点只反映当前最新版框架文档；历史版本入口见索引「版本」分组——有独立 llms.txt 的历史版本直链之，2.2.0 为旧系统 HTML 站点无 md 镜像
  • AI 助手应在使用前核对项目 Aegis 包大版本与索引版本一致
  • /md/ 镜像与站内页面同源；内容有出入时以站内页面和框架源码为准