Repository navigation
[Docs] 补齐 v0.2.25 接入导航、部署说明与文档验收缺口 #1042
Description
背景与范围
对 v0.2.25(commit 326cbd62244aac7dbd7a97a136148231d6a46ce6)进行文档与源码交叉核查,发现以下可复现的文档完整性和操作说明问题。本 Issue 仅跟踪文档、导航及周报 HTML 锚点修复,不要求修改业务功能、重打 tag 或重新发布 Release。
前端统计相关功能背景见 #989、#1010;这里跟踪的是已交付内容的文档补齐,不重复提出配置化采集功能需求。
已确认问题
1. 前端统计接入文档缺少主入口
中文指南与英文契约已存在,但 docs/README.md、文档站中英文 guide 索引和 VitePress 侧栏没有接入入口。正文位于站点根 docs/skillhub 之外,也没有相应站内专题页。
建议增加双语简短入口并链接权威正文,避免复制维护两套长文档。继续明确本版为手动接入、默认关闭,不把未来配置化启用描述为已交付。
2. 统计依赖故障验收步骤无法覆盖启用态
中文指南第 7 步先设置 enabled: false,再停止 Umami;而 observer在关闭态直接返回,因此只能证明关闭态业务正常。
应拆分两个用例:
- 关闭态:不加载 SDK、不采集。
- 启用态依赖故障:在隔离示例中配置有效站点标识并取得明确授权,刷新生效后停止依赖,确认采集失败但搜索等业务仍正常;结束后恢复或清理。
3. 设备码登录与配置生效说明不一致
部署手册把登录命令直接描述为设备码授权,但 CLI 实现优先解析已有 Token,仅无 Token 时进入设备码流程。
同一手册设备 URI 配置段仅写“重启服务”;Compose 环境变量变更需要重建受影响容器,不能用 docker compose restart 代替。站内双语指南已有较准确表述,应保持一致,并补充英文设备 URI 配置摘要。
4. 指定版本安装缺少配置来源固定说明
README 参数说明介绍 --version,未解释 --ref。runtime.sh默认从 main 取得部署文件;仅指定版本会固定镜像但不固定配置来源。
应说明可复现安装需要同时指定,例如 --ref v0.2.25 --version v0.2.25,并核对完整命令的实际执行路径。旧版本示例可一并统一,但不能把旧示例误报为默认安装旧版。
5. 新增响应字段与配置格式说明不足
- 技能详情响应的
webUrl缺少字段契约:需说明公共详情页 URL、配置来源、缺省或无效配置时的 null 语义以及子路径/编码行为;不要误写为自定义外站链接或 CLI resolve 字段。 - 扫描器大小配置已兼容精确整数科学计数法,例如
1.1010048e+08,但文档尚未说明。推荐继续使用整数 byte 值,补充格式兼容说明;现有默认110100480(105 MiB)是正确的,零/负整数钳制行为也应以源码为准。
6. W44 周报跳转正文锚点缺失
W44 HTML的跳转链接使用 #report-content,但正文 main 没有对应 id。构建脚本将最新报告复制为首页,因此一个源缺陷影响 W44 与周报首页。正文仍可阅读,但键盘跳转正文失效。
验收标准
- 从中英文文档站导航/索引可找到统计接入指南,入口链接有效,已交付与未交付能力边界准确。
- 关闭采集和启用态依赖故障为独立、可执行用例,步骤包含恢复/清理。
- 设备码登录的 Token 优先条件、Compose 重建要求及双语配置说明一致。
- 安装参数明确区分镜像版本和部署文件来源,并验证固定版本示例。
- 补充
webUrl与扫描器配置格式说明,与实际代码一致。 - W44 与构建后的首页均有唯一有效正文锚点,键盘跳转可用。
- 文档站构建、内部链接检查及变更页面导航/键盘检查通过。
核查边界
问题依据为上述发布提交的文档、源码和示例静态对照;不将其表述为本轮已完成真实采集服务故障注入或全站浏览器验收。修复时按改动范围补充验证。本 Issue 不包含服务器部署、业务升级或外部文档抓取服务修复。
Activity
github-actions commentedon Oct 30, 2026
Issue Triage
triage/deferredpriority/p3(2.3/5)effort/s(2/5)3/5lowrules-onlyWhy
Next Action
问题分流结果
triage/deferredpriority/p3(2.3/5)effort/s(2/5)3/5低rules-only原因
下一步