0a6e2b7dc4
为插件作者建一个文档站，重点是**能按描述搜到 API**，以及**明确能力边界**。
## 为什么 API 参考要生成而不是手写
公开 API 面有 115 个符号、11 个接口。手抄必然与代码漂移——这是文档站最常见的
死法（本仓 README 里已经有过几处「文档说一套、代码是另一套」）。
所以 `tools/apidoc` 直接从 `sdk/*.go` 提取签名、文档注释与代码块示例，渲染成
`docs/api/*.md`。发现文档不对时改的是**源码注释**，不是生成物。生成页首行带
「勿手改」标记，防止有人改了下次构建白改。
- `extract.go`：go/ast + go/doc 提取（只用标准库，离线可跑，不引入依赖）
- `gensite/`：渲染 Markdown + 检索索引
- `gensite/usages.go`：从 `example/` 21 个示例插件里反查**真实调用点**，
贴在每个 API 下（源码注释里几乎没有可运行示例，但示例插件都是能编译跑的真代码）
## 能力边界：写这个站时查出的三处文档错误
这是本次最有价值的部分。原以为「公开 SDK 里有的 API 外部插件都能用」，
实测对照桥接模板后发现三处不符，站内已更正：
1. **`PluginMgr()` 被写成「仅内置可用」——错的。** 桥接模板第 692 行显式
`base.SetPluginMgrAPI(procPluginMgr{})`，公开 `PluginMgrAPI` 注释也写「外部插件可调用」。
真正的区别是**方法数**：公开面 3 个（ReloadOne/ListLoadedPlugins/IsPluginDisabled），
内部面 9 个。容易混淆是因为两个包里有同名但不同的接口。
2. **`Events()` 外部插件恒为 nil。** `SetEventSubscriber` 全仓只有定义、无调用点，
故 subscriber 从未被注入。外部插件的事件订阅实际由生成的运行时走
`events.subscribe` RPC 完成——旧文档把它当成可用入口，会让人写出必然失效的代码。
3. **`UnregisterOutputChannel` 是静默无效，不是报错。** 桥接只注入 registrar、
不注入 unregistrar，于是 `regOutputUnreg == nil`，函数命中 else 分支**直接返回 nil**
（sdk/plugin.go:539-549）——不报错、通道也没注销。
每条裁定的依据写进 `tools/apidoc/tiers.json`（文件:行号 或 grep 结论），
站上以告警框呈现，读者可自行核对。判断依据三源：桥接模板的 `base.Set*` 注入点、
`internal/sdk` 完整面、`internal/plugin/proc/protocol.go` 的 RPC 表。
## 检索（用户的核心诉求）
两套互补：
- **MkDocs 内置搜索**：全文，中文走 jieba 分词。
- **自建 API 检索**（`docs/javascripts/api-search.js` + `assets/api-index.json`）：
支持四类查询——按名称、**按功能描述**（「注册工具」→ RegisterTool、
「崩溃」→ SetAutoRestart）、按 `限定符.方法`（`memory.recall` → MemoryAPI.Recall）、
按签名片段（`(string) error`）。并标出「仅内置」，避免外部插件作者踩空。
自建的理由：Material 内置搜索按整页文本索引，搜 `InjectText` 会列出所有提到它的
页面，但分不清哪条是它的定义；而且它要等 mkdocs build 才更新。
## 文档结构
- `docs/guide/`：快速开始、Go/Lua 首个插件、能力边界、打包发布、多平台、受限 SDK 与安全
- `docs/api/`：10 个按「你想做什么」划分的章节（工具/阶段/记忆/通道/配置/生命周期/
事件/LLM/常量/桥接）+ 仅内置汇总页
- `docs/versions.md`：SDK 版本语义（跟随内核中版本、patch 恒为 .0）、
1.0.0 是唯一破坏性变更、RPC 协议版本
## 验证
- `mkdocs build --strict` 零告警
- 23 个页面的全部站内链接与锚点可达（自动校验）
- 1440 / 768 / 390px 三视口：无横向溢出、无控制台错误
- 四种检索模式实测有结果且跳转锚点正确
- 构建产物 `site_build/` 已 gitignore
用法：`tools/apidoc/build.sh`（生成+构建）、`tools/apidoc/build.sh serve`（预览）。
3.3 KiB
版本与兼容
SDK 版本语义
SDK 版本跟随内核的中版本，patch 位恒为 .0。
整条内核 1.1.x 线（1.1.0、1.1.1、1.1.7…）共用 SDK 1.1.0；
只有内核进入 1.2.0 这种中版本跃迁时，SDK 才升到 1.2.0。
这样插件作者只需关心「我在为哪个中版本写插件」，不必跟着内核的每个 bugfix 换依赖。 当前内核声明的兼容上限是 SDK 1.3.0。
版本历史
| SDK | 内核 | 变化 | 需要重编？ |
|---|---|---|---|
| 1.3.0 | 1.4.0+ | 驻留子 agent、RecallPolicy 等 |
想用新 API 才需要 |
| 1.2.0 | 1.2.0 / 1.3.x | InjectOptions{NoMemory, ContextPolicy}、六个 *Opts 变体、ChannelDef.ContextPolicy |
不需要 |
| 1.1.0 | 1.1.x | 多模态贯通：Triple.SentenceText、Doc.Attachments、MediaAttachment、InsertWithMedia、媒体注入方法 |
不需要 |
| 1.0.0 | 1.0.0+ | 运行模型变更：C ABI 动态库 → 子进程 + 共享内存 | 需要 |
1.0.0 是唯一一次破坏性变更
.so/.dylib/.dll不再被加载，遇到旧产物会跳过并报可操作错误（不崩溃）。- 业务代码不用改一行 —— 公开 SDK 接口零改动，用新版
hmapdev重编即可。 - 产物从
plugin.so变为plugin.bin；不再需要 cgo。
1.1.0 / 1.2.0 是纯追加
两次都是新增方法由插件调用、内核实现，不调就不受影响。
零值 InjectOptions 与旧的三参数方法完全等价，因此存量插件不需要改、也不需要重编；
想用新字段的重编即可。
!!! tip "什么时候必须重编"
只有两种情况：① 内核跨了中版本（如 1.1 → 1.2）且你用了新 API；
② 内核的 RPC 协议版本变了（.hmap 里的 protocol 字段与内核不匹配）。
后者的错配不会静默失效 —— 握手时会显式拦下。
RPC 协议版本
插件包里带 protocol 字段，必须等于内核的 ProtocolVersion（当前 2）。
协议 v2 引入了调用帧（tool / cleaner / output）与 blocks_ref 媒体块。
v1 插件遇上 v2 内核会拿到空参数，反过来 v2 插件发 blocks_ref 会被 v1 内核静默忽略 ——
两边错配都不报错、只是静默失效，所以协议版本在握手上显式校验。
怎么确认自己在用什么
装的 SDK 版本：
hmapdev sdk current
hmapdev sdk list
插件声明的目标版本在 plg.json 的 sdk 字段。若该版本不在本地存储里，
hmapdev 会明确报错，不静默降级 —— 静默降级会产出与内核协议不匹配的包，
那种失败要到运行时才暴露。
文档站对应的版本
本页与 API 参考 由 tools/apidoc 从源码生成，
内容随源码一起演进。发现文档与代码不一致时，改的是源码注释，
go run ./tools/apidoc 重新生成即可（见下方「维护」）。
维护（给 SDK 维护者）
cd homeagent-sdk
go run ./tools/apidoc -pkgdir ./sdk -out /tmp/api.json
go run ./tools/apidoc/gensite -api /tmp/api.json -out ./docs -examples ./example
mkdocs serve # 本地预览
mkdocs build # 产出 site_build/
API 面的能力分层（哪些 API 仅内置可用）记在 tools/apidoc/tiers.json，
每条裁定都附源码依据 —— 改这里而不是改生成物。