向 AI 提供哪些内容
Sudomimus 以多种机器可读形式发布文档。喂哪一个给助手,取决于你能腾出多少上下文窗口,以及你要的是散文式说明还是正式的 API 契约。
llms.txt 端点
Section titled “llms.txt 端点”三个纯文本端点遵循 llmstxt.org 约定:
| URL | 它是什么 |
|---|---|
https://docs.sudomimus.com/llms.txt | 索引 —— 一份简短清单,链接到下面两份语料。适合那种「按需抓取页面」而非一次性全抓的助手。 |
https://docs.sudomimus.com/llms-full.txt | 完整语料 —— 所有文档页拼接成的单个文件。 |
https://docs.sudomimus.com/llms-small.txt | 精简语料 —— 同一套文档,但裁掉了最重的参考材料。 |
精简版还是完整版?
Section titled “精简版还是完整版?”两份语料覆盖的范围相同 —— 平台共享概念、彼此独立的 Connect/OIDC/原生流程,以及三层规则模型。区别只在深度:
llms-full.txt包含一切,连那些超长的逐方法、逐 payload 参考表(每个 OAuth 提供商、每种规则方法、每个边界情况)都在内。它的体量大约是精简版的三倍。当你的助手上下文窗口够大、又想要一次性完成完整集成时,用它。llms-small.txt砍掉了那些详尽的表格和边角说明,保留概念模型与核心流程。当上下文紧张、或你想让助手先快速把握模型、细节再单独指页给它时,用它。
拿不准就先用 llms-full.txt—— 大多数现代助手都能轻松装下。
按页 Markdown
Section titled “按页 Markdown”在任意文档页 URL 后面追加 .md,即可只抓取这一页的原始 Markdown —— 例如 /zh-cn/connect/three-key-model.md。这是「只给助手一页、而非整套语料」的精确做法。
OpenAPI 参考
Section titled “OpenAPI 参考”要拿到公开 API 的正式请求/响应契约,把助手指向 OpenAPI 3.1 参考,它直接由已发布的规范生成:
- Connect API —— 令牌交换端点(
/establish、/redeem、/refresh),每个 operation 都有独立页面。 - Native API —— 面向原生客户端的 direct-issue 端点(
/direct-issue/steam-ticket、/direct-issue/access-key)。 - Device API —— 面向公开客户端的 device authorization 端点(
/device-authorize、/device-token)。
这些页面是精确路径、参数、请求体与状态码的真实来源 —— 当你要的是强类型客户端代码、而非从散文推断出来的猜测时,把它们喂给助手。
llms*.txt 端点和 OpenAPI 参考都会随文档每次更新一起重建 —— 没有滞后的「AI 版本」。如果助手缓存了旧版本,让它重新抓一次即可。