Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

本计划把已核对的 DesireCore 接口整理成公开站点中的“集成与 API”区域。用户应能根据文档取得正确的服务地址和授权凭据,完成一次调用,理解响应与运行结果,并处理实际错误。实施采用主 Agent 协调、多个 subAgent 按接口能力并行核查、编写和验证的方式;先交付一个完整可用的接入流程,再按各项能力的实际进度发布扩展参考和 OpenAPI 下载。

状态:P0—P6 选定范围实施与发布验收完成。源码 #4798 已合并;文档 #72 及场景入口修复 #73 已合并并完成网站自动部署;16个API页面、8个下载和全站716URL线上验收通过。即时站内搜索尚未返回新增API页,未宣称搜索收录完成。更新日期:2026-10-15。
状态:P0—P6 选定范围实施与发布验收完成。源码 #4798 已合并;文档 #72 及场景入口修复 #73 已合并并完成网站自动部署;16个API页面、8个下载和全站716URL线上验收通过。站内搜索已重抓更新,16个API页面的中英文标题、关键端点及浏览器弹窗验收通过。更新日期:2026-10-15。

## 1. 实施目标与完成标准

Expand Down Expand Up @@ -485,3 +485,11 @@ P0—P5 表示工作范围,不能作为全局串行阶段。主 Agent 先完
即时站内搜索返回19条已有Webhook结果,未返回新增API路径;新页均可通过导航访问且sitemap/robots允许抓取。已完成索引状态检查,但不把可抓取写成已经收录,也不把搜索未更新当作部署失败。

来源清单固定最终源码与对应内部docs指针;内部全量发现台账保留原核查快照,不将本次选定合同差异复核冒充全量重新扫描。最终发布链、部署编号、生产逐项结果及限制保存在 `api/publication.json` 与 `api/production-verification.json`。

## 16. 站内搜索索引更新与验收(2026-10-15)

管理端确认当前crawler每月23日运行,上次完整抓取为9月23日,本次API发布后尚未运行;下一次计划抓取为10月23日。前端索引 `DesireCore Docs` 与crawler写入索引一致,域名/路径规则覆盖中英文API,maxUrls无限制;页面HTML、robots、canonical及DocSearch元数据均满足抓取条件。根因是既有月度调度尚未执行本次更新。

沿现有配置手动抓取,于北京时间19:30:02开始、19:32:35结束,734个URL成功、2个内容类型忽略、2个旧v10.0.180中英文更新日志因记录过大失败。索引从19,324条更新至21,572条。未修改抓取周期,未发布编辑器草稿。中英文Webhook单页提取测试各生成110条记录。

正式搜索验收使用前端真实language/tag上下文过滤,16/16目标页面标题、4/4关键端点、2/2旧页对照全部命中,目标记录语言/current版本/标签均正确;中英文搜索弹窗均显示目标Webhook指南且点击可打开对应页面。首次命中排名1—19,不将索引覆盖误写成所有结果均排名第一。逐项证据见 `api/search-verification.json`,发布摘要已更新。
16 changes: 15 additions & 1 deletion api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ pnpm api:check -- --build

`api:check` 检查清单、两种语言的显式 slug、JSON 示例、版本提示框及 OpenAPI 范围、引用、鉴权和下载链接;`--build` 额外读取本地 HTML 和 sitemap。它不读取私有源仓库、不访问生产 URL,也不证明翻译语义或接口运行已验收。

## 搜索索引维护

网站自动部署与 Algolia 索引更新是两个独立步骤。现有 DocSearch crawler 按月在每月 23 日运行,部署成功不能证明新增页面已经收录。当前使用应用 `68TB6NUYVW`、索引 `DesireCore Docs` 和 crawler `26591011-cca2-4aaa-9c75-75f1f0b3fad5`;周期时间以管理端显示为准。

发布新增或调整后的 API 页面后,按以下步骤验收:

1. 先确认生产页面、canonical、robots、双语 sitemap 与正文正常。API 页应有可直接读取的 `.theme-doc-markdown`、标题及 `docsearch:language`、`docsearch:version`、`docsearch:docusaurus_tag` 元数据。
2. 在现有 crawler 的 URL Tester 中分别检查中英文页面的记录提取,再手动触发该 crawler 抓取。保留已保存配置和现有月度周期,不将编辑器草稿发布或新建密钥作为常规重抓步骤。
3. 等待该次抓取结束,记录时间、成功/忽略/失败 URL 数与索引记录数;检查失败原因,不能只看记录总数增长。先保留路径规则、选择器、调度等变量,只有抓取证据指向具体配置问题时再处理该项。
4. 按站点实际过滤条件查询:中文 `language:zh-Hans`、英文 `language:en`,并使用 `docusaurus_tag:default OR docs-default-current`。逐项检查 16 个双语 API 页面标题、代表性端点和两种语言的旧页面对照,确认返回目标 URL、`current` 版本和正确 tag;结果排名不要求固定第一。
5. 在网站搜索框分别查找“智能体 Webhook”和“Agent Webhook”,打开目标页面,再更新 [搜索验收记录](./search-verification.json)。公开记录只保留必要的时间、配置、查询与结果证据,不保存密钥、账号身份、请求头或本机绝对路径。

2026-10-15 的手动抓取使索引从 19,324 条增至 21,572 条,22 项查询及双语浏览器检查通过。该次抓取仍有两篇 `v10.0.180` 更新日志因记录过大而失败;API 搜索验收通过不等于全站抓取没有失败。完整结果见搜索验收记录。

## 清单字段

`pages` 列出本批公开页面的 `id`、源码 `file` 和稳定 `slug`。`endpoints` 使用以下字段:
Expand Down Expand Up @@ -64,4 +78,4 @@ pnpm api:check -- --build

## 当前验证记录

参见 [核查与验证](./verification.md)、[发布与验收摘要](./publication.json)及[生产逐项报告](./production-verification.json)。后续更改认证、路由、配置入口或结果交付时,只重新核对受影响合同和相关示例,不将本批测试结果传播为其它功能的运行保证。
参见 [核查与验证](./verification.md)、[发布与验收摘要](./publication.json)、[生产逐项报告](./production-verification.json)及[搜索验收记录](./search-verification.json)。后续更改认证、路由、配置入口或结果交付时,只重新核对受影响合同和相关示例,不将本批测试结果传播为其它功能的运行保证。
37 changes: 31 additions & 6 deletions api/publication.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,37 @@
}
},
"search": {
"checkedAt": "2026-10-15T09:10:17.966Z",
"httpStatus": 200,
"query": "Webhook",
"hits": 19,
"newApiUrls": [],
"status": "New API pages not returned by immediate search; page deployment, sitemap inclusion and crawlability passed. Search indexing is not claimed complete."
"checkedAt": "2026-10-15T11:34:17.100Z",
"status": "passed",
"rootCause": "The existing crawler runs on the 23rd day of each month; the previous complete crawl was on 2026-09-23, before API publication.",
"crawlerId": "26591011-cca2-4aaa-9c75-75f1f0b3fad5",
"schedule": "on the 23 day of the month",
"manualCrawl": {
"startedAt": "2026-10-15T11:30:02Z",
"completedAt": "2026-10-15T11:32:35Z",
"successUrls": 734,
"ignoredUrls": 2,
"failedUrls": 2,
"recordsBefore": 19324,
"recordsAfter": 21572
},
"titleTargets": 16,
"titleTargetsMatched": 16,
"endpointChecks": 4,
"endpointChecksPassed": 4,
"legacyControls": 2,
"legacyControlsPassed": 2,
"contextualFilter": "language:<locale> AND (docusaurus_tag:default OR docusaurus_tag:docs-default-current)",
"browserChecks": {
"zhQuery": "智能体 Webhook",
"enQuery": "Agent Webhook",
"targetLinksOpened": true
},
"details": "search-verification.json",
"limitations": [
"The monthly schedule is unchanged; website deployment does not itself trigger this external crawler.",
"The two oversized-record failures concern the Chinese and English v10.0.180 changelog pages, not API pages."
]
},
"limitations": [
"No commercial model, packaged-client or production business-operation acceptance is inferred from this documentation deployment.",
Expand Down
Loading
Loading