LLM / AI 检索

文档站会自动维护一份标准的 llms.txt 索引，以及一组给 AI 直接读取的 Markdown 镜像页，方便模型按文档树逐步抓取内容。它是随 npm 包分发的 hb-sdk Agent Skill 唯一持续维护的 hb-sdk 事实入口；Skill 本身不复制 API、CLI、Guide 或 Recipe 正文。

入口

部署后的文档站可直接访问：

• llms.txt
• llms/index.md

其中：

• llms.txt：AI 入口索引，按 Docs / API Reference / Guides / Recipes 组织。
• llms/：文档站的 Markdown 镜像目录，保留 Guide / Reference / Recipes 的相对结构。

推荐读取顺序

1. 先读取 llms.txt
2. 再进入：
   • llms/guide/index.md：如果要理解接入路径
   • llms/reference/index.md：如果要查 API
   • llms/recipes/index.md：如果要找场景用法
3. 需要更细时，再进入对应的 root/、protocol/、functions/、interfaces/ 或 types/index.md

相对链接统一以 https://docs.xiaoheihe.cn/hb_sdk/ 为基准解析。AI 应在每次任务中重新读取索引和所需页面，并确认响应是 Markdown 而不是 HTML 应用壳、登录页或错误页。索引或必需页面不可用时，不应使用包内副本、registry 快照或模型记忆补齐。

内容定位

• llms.txt 适合做入口索引，不适合承载完整文档正文。
• 详细 API 内容以 llms/reference/ 下的 Markdown 镜像为准。
• Guide / Recipes 适合给 AI 提供接入上下文和场景用法建议。
• 本地 hb-sdk doctor 只校验已安装 Skill 的版本和完整性，不检查线上文档可用性。