Skip to content

Doc Review — 2026-09-08 (diff mode) - #370

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-09-08-081335
Open

Doc Review — 2026-09-08 (diff mode)#370
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-09-08-081335

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 8, 2026

Copy link
Copy Markdown

Doc Review — 2026-09-08

Mode: diff (since 2026-09-07T08:01:47Z)
Findings: 22 total — 1 high, 11 medium, 10 low

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre ai-sre/sessions.mdx 排队撤回:POST /safari/session/message/cancel 服务端语义(仅作者、removed/consumed/forbidden、user_message_cancelled 帧)
f002 missing_coverage ai-sre openapi/api-catalog.mdx session/get 响应新增 pending_messages 字段说明(Note);/message/cancel 目录行暂不加(auth=service,见 Cross-repo follow-ups)
f003 missing_coverage ai-sre ai-sre/sessions.mdx Agent 提问:新消息自动跳过挂起提问(user_replied_with_message)、迟到回答转普通消息
f004 missing_coverage ai-sre ai-sre/sessions.mdx 会话导出:NDJSON 行类型表(10 类)、call_id 配对、每部分一行、model 取会话绑定模型
f005 missing_coverage ai-sre ai-sre/sessions.mdx 任务计划:仅 web+IM 维护、automation/API 不提供、3 步及以上才创建
f006 missing_coverage on-call on-call/channel/noise-reduction.mdx 静默策略复制章节(入口/跨空间结果确认/快速静默除外/复制字段)
f007 missing_coverage on-call on-call/configuration/custom-forms.mdx 批量认领/关闭与自定义表单并集交互章节(先行执行+反选/并集表单/放弃提示)
f008 missing_coverage on-call on-call/channel/escalation-rule.mdx (+noise-reduction) 复制弹窗 39/500 字符限制
f009 missing_coverage on-call/integration .../alert-pipelines.mdx 空规则列表 = 不启用告警处理(Note)
f010 missing_coverage on-call/integration .../label-enhancement.mdx 空规则列表 = 不启用标签增强(Note)
f011 missing_coverage on-call/integration/sso .../role-team-sync.mdx SSO 默认角色/团队删除保护(Warning,SSO/同步关闭与强制删除不豁免)
f012 missing_coverage platform platform/permission-design.mdx 自定义角色删除保护(Note)
f013 missing_coverage platform platform/team-members.mdx 默认团队删除保护(Warning 补充)
f014 missing_coverage platform platform/team-members.mdx 成员搜索:纯数字精确匹配成员 ID(新小节)
f015 missing_coverage monitors NEW: monitors/targets/overview.mdx (zh+en) 重建监控对象页文档(7 列/列选择器/ASCII 前缀搜索/分页/每行 AI 分析/ServiceMap 已下线),docs.json 双语导航注册
f016 missing_coverage monitors 未应用到 docs(install-agent 页与 68d8181 退役决策冲突)→ Cross-repo follow-ups
f017 stale_content cli developer/cli.mdx 删除已退役 Agent 回退/诊断角色表述
f018 stale_content cli developer/go-sdk.mdx 删除 ToolsInvoke 的 Agent 回退子句
f019 stale_content go-sdk developer/overview.mdx 计数 349→340 操作 / 39→38 服务(已从 spec 验证)
f020 stale_content go-sdk developer/cli.mdx 计数 348/345→340/337 (已从 spec + zz_generated 验证)
f021 missing_coverage derivative changelog/changelog.mdx (zh+en) 新增 2026-09-08 更新日志条目(静默复制/批量表单/成员 ID 搜索/ServiceMap 下线与 monit-agent 退役)
f022 missing_coverage derivative flashduty-website 不编辑 docs → Cross-repo follow-ups

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
  • zh/en 内容一致性(已逐文件核对行数差异,均为镜像翻译)

Cross-repo follow-ups (flashduty-website)

  • f022 — website changelog: 官网 changelog 最新条目为 2026-08-11,本窗口功能(静默策略复制、批量表单并集、成员 ID 搜索、monit-agent/ServiceMap 退役)均无官网条目。需官网团队新增 2026-09-08 条目(content/changelog/2026-09-08-*.mdx + .zh.mdx)。
  • f016 — FE 空态链接 404(fc-foundation-app/monit,非 website):监控对象页空态「去接入」仍打开 docs.flashduty.com/{zh|en}/monitors/targets/install-agent,该页已随 68d8181 删除。需前端确认 monit-agent 是否仍可安装用于目标上报:若可安装请恢复/更新链接(建议指向引擎安装文档),若已退役请同步更新空态文案与 agent_version 列。
  • f002 — session/message/cancel 公开性(fc-pgy):该端点注册为 Auth:"service"(app key 可调用但排除在公共 OpenAPI 之外,api-review 仅生成 auth="all"),故本次未加入 api-catalog 行。若产品决定将其公开,需先在 fc-pgy 改为 auth="all" 并交 api-review 重新生成(operationId 将为 session-write-message-cancel),再补目录行。
  • api-reference 再生成:fc-safari session/get 响应新增 pending_messages、新增 /message/cancel 路径;api-reference/safari.openapi.{zh,en}.json 需由 api-review 流程下次生成时同步(本 PR 未手工改写生成文件)。

Mapping warnings

  • monit-webapi / monit-edge:仓库为私有,无法 clone(记录为 skip,本次 monitors 模块仅覆盖前端子模块 diff;后端变更未审查)。

Skipped

None(findings 文件中无人工移除项;f016/f022 的操作归属见 Cross-repo follow-ups,f002 的 /message/cancel 目录行见上)。

- ai-sre: session message cancel, pending-question semantics, export NDJSON
  line schema, todo-list channel scoping; api-catalog pending_messages note
- on-call: silence-rule copy, batch ack/close custom-form union, copy dialog
  field limits; integration empty-rule-list semantics
- sso/platform: SSO default role/team deletion guard, member ID search
- monitors: restore targets overview page (+ nav registration)
- developer: refresh API operation/service counts, drop retired monit-agent
  fallback references
- changelog: 2026-09-08 entry (zh/en)
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.

0 participants