mirror of
https://gitcode.com/JianFeeeee/homeagent-sdk.git
synced 2026-10-03 15:44:11 +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`（预览）。
87 lines
4.1 KiB
Markdown
87 lines
4.1 KiB
Markdown
# 插件 SDK 文档站
|
||
|
||
用 MkDocs Material 构建的 SDK 文档站。**API 参考不是手写的** ——
|
||
它从 `sdk/*.go` 的源码注释生成，因为手抄必然与代码漂移。
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
mkdocs.yml 站点配置（导航、主题、中文检索）
|
||
docs/
|
||
├── index.md ┐
|
||
├── versions.md │
|
||
├── guide/*.md ├─ 手写：指南、边界说明、版本
|
||
├── api/index.md │
|
||
├── javascripts/ │
|
||
│ └── api-search.js │ 自建 API 检索（按名称/描述/签名）
|
||
├── stylesheets/extra.css ┘
|
||
├── api/*.md ┐ 生成物 —— 勿手改
|
||
├── examples/index.md │ （build 时覆盖）
|
||
└── assets/api-index.json ┘
|
||
tools/apidoc/ 生成器（本仓 Go 代码，零外部依赖）
|
||
├── extract.go 从源码提取符号、注释、分层
|
||
├── tiers.go 应用能力分层（public / builtin / bridge）
|
||
├── tiers.json **能力边界的事实源**（每条附源码依据）
|
||
├── gensite/main.go 渲染 Markdown + 检索索引
|
||
├── gensite/usages.go 从 example/ 抽取真实调用点
|
||
└── build.sh 一键生成 + 构建
|
||
```
|
||
|
||
## 构建
|
||
|
||
```bash
|
||
tools/apidoc/build.sh # 生成 + 构建到 site_build/
|
||
tools/apidoc/build.sh serve # 本地预览（http://127.0.0.1:8000）
|
||
```
|
||
|
||
依赖：Go 1.21+、`mkdocs-material`（`pip install mkdocs-material`）、
|
||
`jieba`（中文检索分词，`pip install jieba`）。
|
||
|
||
## 两条设计原则
|
||
|
||
**① API 参考从源码生成。** 签名、说明、示例全部来自 `sdk/*.go` 的文档注释。
|
||
发现文档不对时，**改的是源码注释**，然后重新生成。生成页首行有「勿手改」标记。
|
||
|
||
**② 能力边界是可核对的事实，不是印象。** 哪些 API 外部插件拿不到，
|
||
逐条记在 `tools/apidoc/tiers.json`，每条都写清**可复核的依据**
|
||
（文件:行号、或 `grep` 结论）。判断标准是：
|
||
|
||
| 依据 | 含义 |
|
||
|---|---|
|
||
| `tools/hmapdev/templates/proc_main.go.tmpl` 的 `base.Set*` 调用 | 外部插件运行时**实际注入**哪些能力 |
|
||
| `internal/sdk` | 内置插件用的完整接口（对照出外部缺什么） |
|
||
| `internal/plugin/proc/protocol.go` | 外部插件**能发哪些 RPC** |
|
||
|
||
文档站上每条「仅内置」告警都带这个依据，读者可自行核对。
|
||
|
||
### 为什么这个边界值得单独维护
|
||
|
||
写这个站时，实测发现文档与源码有**三处不符**（现已在站内更正）：
|
||
|
||
1. `PluginMgr()` 曾被写成「仅内置可用」——实际桥接**显式注入**了它。
|
||
真正的区别是方法数：公开面 3 个，内部面 9 个（两个包里同名不同接口）。
|
||
2. `Events()` 曾被当作可用的事件订阅入口——实际桥接**不注入** subscriber，
|
||
外部插件拿到的恒为 nil（`SetEventSubscriber` 全仓无调用点）。
|
||
外部插件的事件订阅实际由生成的运行时走 `events.subscribe` RPC 完成。
|
||
3. `UnregisterOutputChannel` 易被当成「可用但会报错」——实际返回 nil，
|
||
**静默无效**（桥不注入 unregister），不报错也不注销。
|
||
|
||
## 检索
|
||
|
||
站内有两套检索，互补：
|
||
|
||
- **MkDocs 内置搜索**（右上角）：全文检索，中文走 jieba 分词。
|
||
- **自建 API 检索**（首页与 API 参考页的输入框）：读 `assets/api-index.json`，
|
||
专门解决「**按描述找 API**」——搜「注册工具」能找到 `RegisterTool`，
|
||
搜「崩溃」能找到 `SetAutoRestart`，并可区分公开/仅内置。
|
||
|
||
自建检索支持四类查询：名称、描述（中英文）、`限定符.方法`
|
||
（如 `memory.recall`）、签名片段（如 `(string) error`）。
|
||
|
||
## 维护提示
|
||
|
||
- **改了 `sdk/*.go` 的注释或签名** → 重跑 `build.sh`，改动自动进文档。
|
||
- **改了能力边界** → 改 `tiers.json`，不要直接改生成的 `.md`。
|
||
- **新增示例插件** → 自动出现在「示例插件」页的用法表里（扫 `example/`）。
|
||
- `site_build/` 是构建产物，已 gitignore，不要提交。
|