mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-09-25 03:18:06 +00:00
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`（预览）。
116 lines
2.6 KiB
CSS
116 lines
2.6 KiB
CSS
/* API 即时检索与文档站的少量本地样式。
|
|
只补 Material 没覆盖的部分，不覆盖主题变量（保持深浅色自动适配）。 */
|
|
|
|
#api-search {
|
|
margin: 1.2rem 0 2rem;
|
|
}
|
|
|
|
.api-input {
|
|
width: 100%;
|
|
padding: 0.7rem 0.9rem;
|
|
font-size: 1rem;
|
|
border: 1px solid var(--md-default-fg-color--lightest);
|
|
border-radius: 0.3rem;
|
|
background: var(--md-default-bg-color);
|
|
color: var(--md-default-fg-color);
|
|
}
|
|
|
|
.api-input:focus {
|
|
outline: 2px solid var(--md-accent-fg-color);
|
|
outline-offset: 1px;
|
|
border-color: transparent;
|
|
}
|
|
|
|
.api-hint {
|
|
color: var(--md-default-fg-color--light);
|
|
font-size: 0.8rem;
|
|
margin: 0.6rem 0 0;
|
|
}
|
|
|
|
.api-count {
|
|
color: var(--md-default-fg-color--light);
|
|
font-size: 0.75rem;
|
|
margin: 0.8rem 0 0.4rem;
|
|
}
|
|
|
|
.api-results {
|
|
list-style: none;
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
|
|
.api-result {
|
|
padding: 0.55rem 0.6rem;
|
|
border-left: 3px solid var(--md-primary-fg-color);
|
|
margin-bottom: 0.4rem;
|
|
background: var(--md-code-bg-color);
|
|
border-radius: 0 0.2rem 0.2rem 0;
|
|
display: flex;
|
|
flex-wrap: wrap;
|
|
align-items: baseline;
|
|
gap: 0.45rem;
|
|
}
|
|
|
|
.api-name {
|
|
font-family: var(--md-code-font-family, monospace);
|
|
font-weight: 700;
|
|
font-size: 0.85rem;
|
|
}
|
|
|
|
.api-sig {
|
|
font-size: 0.72rem;
|
|
color: var(--md-default-fg-color--light);
|
|
background: none;
|
|
padding: 0;
|
|
overflow-wrap: anywhere;
|
|
}
|
|
|
|
.api-desc {
|
|
flex-basis: 100%;
|
|
font-size: 0.78rem;
|
|
color: var(--md-default-fg-color--light);
|
|
}
|
|
|
|
.api-loc {
|
|
flex-basis: 100%;
|
|
font-size: 0.68rem;
|
|
color: var(--md-default-fg-color--lighter, var(--md-default-fg-color--light));
|
|
font-family: var(--md-code-font-family, monospace);
|
|
}
|
|
|
|
.api-badge {
|
|
font-size: 0.62rem;
|
|
padding: 0.08rem 0.34rem;
|
|
border-radius: 0.6rem;
|
|
font-weight: 600;
|
|
white-space: nowrap;
|
|
}
|
|
|
|
.api-badge-builtin {
|
|
background: rgba(245, 158, 11, 0.18);
|
|
color: #b45309;
|
|
border: 1px solid rgba(245, 158, 11, 0.5);
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .api-badge-builtin {
|
|
color: #fbbf24;
|
|
}
|
|
|
|
/* 「仅内置」告警块里的依据说明通常很长，窄屏下允许更小字号。 */
|
|
@media screen and (max-width: 44.98em) {
|
|
.api-sig { font-size: 0.68rem; }
|
|
}
|
|
|
|
/* 签名与长类型定义可能超出正文宽度（如 ContentBlock 的字段列表）。
|
|
highlight 代码块默认不换行，靠横向滚动；把默认改为换行显示，
|
|
因为文档读者更希望一眼看全签名而不是拖滚动条。 */
|
|
.md-typeset pre > code {
|
|
white-space: pre-wrap;
|
|
overflow-wrap: anywhere;
|
|
}
|
|
|
|
/* 接口方法表里的签名可能很长，允许在任意位置折行。 */
|
|
.md-typeset table code {
|
|
overflow-wrap: anywhere;
|
|
}
|