Skip to content

Doc Review 2026-10-08 — CLI integration group & dashboard commands, stale API counts - #1024

Merged
ysyneu merged 1 commit into
mainfrom
doc-review/2026-10-08-081100
Oct 8, 2026
Merged

ysyneu merged 1 commit into
mainfrom
doc-review/2026-10-08-081100

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 8, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-08

Mode: diff (since 2026-10-07T08:02:09Z)
Findings: 5 total — 0 high, 2 medium, 3 low

窗口内 7 个源仓库有提交(fc-foundation-app 5、fc-safari 9、flashduty-cli 2、flashduty-website 3、flashduty-app 3、monit-webapi 1、flashduty-runner 2),其余 9 个映射仓库按 git rev-list -1 --before 计算的窗口起点提交与 origin/<默认分支> 当前 SHA 完全相同(fc-event/fc-oncall/fc-datasource/fc-pgy/fc-rum/fc-statuspage/flashduty-mcp-server/terraform-provider-flashduty/go-flashduty)。

Changes

Finding Type Module Doc Action
f001 missing_coverage cli zh/developer/cli.mdx + en/developer/cli.mdx 「全量命令覆盖」的「集成与 Webhook」条目补上新的顶层命令组 integration(info / list / type-list / create / update / delete / enable / disable / key-rotate)
f002 config_drift cli zh/developer/cli.mdx + en/developer/cli.mdx 「全量命令覆盖」段落的规范操作数与生成命令数由 338 / 334 更正为 365 / 361(手工实现命令仍为 4 条)
f003 missing_coverage cli zh/developer/cli.mdx + en/developer/cli.mdx monit 章节新增「仪表盘与规则分组(dashboard-* / folder-list)」小节,列出 17 条 dashboard-* 命令与 folder-list 的用法,并说明 --expected-revision 乐观锁与「删除进回收站、保留 30 天」
f004 config_drift on-call zh/on-call/configuration/personal-settings.mdx + en/on-call/configuration/personal-settings.mdx Android 上架市场清单移除小米(控制台两处 App 下载入口已下线小米应用市场)
f005 config_drift derivative zh/on-call/comparison/vs-pagerduty.mdx + en/on-call/comparison/vs-pagerduty.mdx 产品对比页 CLI 一行的「334 个生成的 API 操作命令」更正为 361
  • f002 的 365/361 有两个独立来源对照:flashduty-cli internal/cli/zz_generated_manifest.go 的 generatedOpIDs 在窗口起点是 334 条、现在 361 条;同一窗口内本仓库 api-reference/openapi.{zh,en}.json 是 365 个操作。365 − 361 = 4,与文档列出的 4 条手工实现命令逐一对应,两个数字互相印证。
  • zh 先写、en 由 zh 派生;本轮没有新建页面,未改动 docs.json。

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs
  • f003 的仪表盘小节请重点核对:命令名与 --expected-revision / 回收站保留 30 天的说法取自 flashduty-cli internal/cli/zz_generated_dashboards.go 的生成帮助文本
  • f004 的小米下架是暂时下架(控制台源码注释「小米应用市场暂时下架,重新上架后恢复」),重新上架后需要把该市场加回清单
  • f005 只改 Flashduty 侧单元格,竞争对手段未动

Cross-repo follow-ups (flashduty-website)

None.

本轮 flashduty-website 的窗口变更只有 2 篇博客(content/blog/redis-actor-session-runtime.mdx 及其中文版与配图),不属于 derivative_surfaces.website_changelog 的 content/changelog/ 目录,也不构成产品功能发布,因此没有派生面 findings;官网更新日志与集成目录无需改动。

Mapping warnings

  • derivative_surfaces.comparison_page.paths 指向 on-call/quickstart/comparison.mdx,该文件不存在(实际产品对比页在 on-call/comparison/vs-pagerduty.mdx 与 vs-opsgenie.mdx)。这是连续第 5 轮出现同一个问题(此前 PR docs: doc-review 2026-10-02 (diff) — AI SRE nav, context file tree, borrowed-integration vendor cards #939 上报过),该派生检查在 skill 里一直是空转的,本轮按实际目录人工补跑,产品对比页命中 f005。修复位置在 skill 的 mapping.yaml,不在 docs 仓库。
  • base_path 使用 docs 仓库的同级目录;fc-foundation-app 的 6 个子模块(src/Packages/{saas,monit,rum,ai-sre,ai-assistant,meow-ui})按 .gitmodules 映射为独立仓库克隆单独核对——本轮 fc-saas-monit 的窗口起点与 HEAD 相同,无变更。

Skipped

以下候选经核对后不落地(含理由):

候选 出处 不落地的理由
新增仪表盘面板类型 incident_list monit-webapi types/dashboard/{contract,validate,variants}.go、logic/logic_dashboard_runtime.go 前端 fc-saas-monit 全仓无 incident_list 字样、窗口内无提交,即无渲染器落地。按「前端为准」规则,后端保留类型不入文档;API 契约侧已由本仓库 api-reference(PR #1023)覆盖
私有化控制台自身 RUM 上报的 consoleRum 应用设置 fc-foundation-app src/store/types.ts、src/utils/flashcat-rum.ts、src/pages/OnPremises/Settings.tsx 本仓库没有部署级 app_settings 页面(app_settings / rumIngestEndpoint 在 zh、en 全量正文中 0 命中),没有可编辑的目标文档;该仓库自带的 docs/app-settings.md 已在同一提交内同步
@flashcatcloud/browser-rum ^0.0.5 → ^0.3.0 fc-foundation-app package.json 依赖升级,按规则跳过;其带来的 sessionOnError / sessionReplayOnError 语义本仓库 zh/rum/quickstart/app-management.mdx 已有「异常会话补采」条目
故障时间线「操作人 + AI SRE」联合署名 flashduty-app src/pages/incident/detail/(Timeline)/StepTemp.tsx、types.ts、zh、en 的 incident.json 移动端只是跟齐 PC 端既有渲染(源码注释「与 PC 一致」),后端 via 字段与 PC 行为均在窗口之前就已存在,属窗口前的既有缺口;且本仓库无描述时间线署名规则或无对应目标页
通知模板新增 dingtalk_app_war_room_enabled / slack_app_war_room_enabled flashduty-cli internal/cli/zz_generated_notification_templates.go、fc-safari reference/template.md 产品侧已文档化:zh/on-call/advanced/war-room.mdx 说明「创建作战室」按钮由通知模板的卡片字段开关控制(默认关闭)。生成命令的入参按文档既定口径由 --help 探索,不再逐字段入正文
safari session-list --person-ids、has_open_tasks flashduty-cli internal/cli/zz_generated_sessions.go、fc-safari reference/safari.md 同上:属生成命令的字段级变化,文档「全量命令覆盖」已明确生成命令入参映射 API、用 --help 逐层探索
sandbox / runner 版本号 0.1.13 → 0.1.16 fc-safari etc/environment.yml 内部灰度与版本地板配置,文档不写具体版本号,BYOC 安装文档用 latest
Knowledge Pack → Knowledge 的用词(提示词、冲突错误文案) fc-safari logic/contextedit/plan.go、cmd/api/knowledge/knowledge.go 已在 PR #428 落地为「知识」,正文 知识包 0 命中(仅 1 处 2026 年历史更新日志条目保留当时措辞)
EventContent 新增 source / task_id / agent_name / wait_for_reply fc-safari types/session.go 会话消息冷加载的内部线协议标记,供前端渲染子代理回报气泡使用,不是用户可配置项
flashduty-cli 打包版本 v1.5.7 → v1.5.9 flashduty-runner scripts/bundle-tools.sh、scripts/tool-checksums.txt runner 内置工具包的打包脚本与校验和,文档用 latest 不锁版本

… commands, API counts

- cli.mdx: add the new top-level integration command group to the coverage list
- cli.mdx: correct the OpenAPI operation counts 338/334 -> 365/361
- cli.mdx: document monit dashboard-* and folder-list commands
- personal-settings.mdx: drop Xiaomi from the Android app store list (delisted in console)
- vs-pagerduty.mdx: 334 -> 361 generated CLI commands
@ysyneu
ysyneu merged commit 808e7db into main Oct 8, 2026
1 check passed
@ysyneu
ysyneu deleted the doc-review/2026-10-08-081100 branch October 8, 2026 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant