Skip to content

docs: doc-review 2026-10-16 — automation execution location, RUM resolve mode, IM member auto-linking, CLI/SDK drift - #1062

Closed
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-16-085831
Closed

flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-16-085831

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 16, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-16

Mode: diff (since 2026-10-15T08:00:13Z)
Findings: 28 total — 5 high, 17 medium, 6 low

Window: previous successful run → this run. Source diffs were taken against the last first-parent
mainline commit before the window start of each repo (git rev-list --first-parent -1 --before=… origin/main).
Files changed in this PR: 34 (17 zh pages + their en counterparts, no new/renamed paths, no docs.json change).

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre ai-sre/automations.mdx 新增「执行位置(规则跑在哪里)」一节,改写顶部 Note 的适用范围
f002 missing_coverage ai-sre ai-sre/automations.mdx 「新建自动化」补 IM 会话内创建 + run_in/team_id 字段表 + 「作用域与权限」新增 IM 执行位置一行
f003 feature_drift ai-sre ai-sre/automations.mdx 运行历史「名称」列补 IM 运行不显示会话标识;trigger_kind 段与「立即执行」改写
f004 stale_content ai-sre ai-sre/automations.mdx 执行位置取值由 Web 控制台 改为 Web
f005 stale_content ai-sre ai-sre/automations.mdx skipped 改为三种情形并补 chat_scope_mismatch 原因行
f006 missing_coverage ai-sre ai-sre/automations.mdx 补 IM 执行位置不使用规则执行环境的例外
f020 missing_coverage ai-sre ai-sre/im.mdx IM 触发方式由两种改为三种,新增「群内自动化回帖」卡片与交叉链接
f021 missing_coverage ai-sre ai-sre/sessions.mdx 上传附件补图片专属规则(适配边界、40 兆像素上限、损坏图片失败)
f040 stale_content on-call on-call/channel/noise-reduction.mdx 删除「切换聚合方式先弹确认框」的表述
f041 feature_drift on-call on-call/configuration/filter-conditions.mdx 通配匹配补「字面匹配」与 /.../ 正则写法及存量值改写说明(含 routing-rules)
f042 stale_content on-call on-call/channel/noise-reduction.mdx 严格聚合关闭时的说明改为「两边都为空视为相同,但至少一个字段有值」
f062 stale_content on-call/integration on-call/integration/instant-messaging/slack.mdx Slack 删除整节成员关联,改为说明不提供关联及按邮箱识别成员的实际机制
f060 feature_drift on-call/integration on-call/integration/instant-messaging/dingtalk.mdx 钉钉「关联用户」新增「自动关联」小节并更新权限表与一键关联说明
f061 feature_drift on-call/integration on-call/integration/instant-messaging/lark.mdx 飞书新增「自动关联」小节并更新一键关联说明
f080 missing_coverage rum rum/error-tracking/issue-status.mdx Issue 状态页新增「解决方式」一节并修正多处复现/重开表述
f081 feature_drift rum rum/error-tracking/error-viewing.mdx error-viewing 的状态数量与重开条件描述按 solve mode 修正
f100 missing_coverage cli developer/cli.mdx automation create 新增 --run-in 行与 IM 绑定创建说明
f101 stale_content cli developer/cli.mdx --team-id 语义改为「省略即继承 IM 会话范围」
f102 stale_content cli developer/cli.mdx --cron-expr 补分钟必须为固定 0–59 整数、最快每小时
f103 config_drift cli developer/cli.mdx 安装默认目录改为 PATH 上现有 flashduty 所在目录,并补 runner 托管守卫
f104 missing_coverage cli developer/cli.mdx 补 monit folder-health/-create/-update/-move/-delete 与返回结构说明
f105 missing_coverage go-sdk developer/go-sdk.mdx client.RuleFolders 行与新增「规则分组」小节
f106 feature_drift go-sdk developer/go-sdk.mdx client.Automations 行与新增「AI SRE 自动化规则」小节
f200 missing_coverage derivative changelog/changelog.mdx 新增 2026-10-16 changelog 块(三项)
f201 missing_coverage derivative on-call/comparison/vs-pagerduty.mdx vs-pagerduty「IM 原生协同」Flashduty 侧补一句
f202 missing_coverage derivative on-call/comparison/vs-opsgenie.mdx vs-opsgenie「IM 原生排障」Flashduty 侧补一句
f203 missing_coverage derivative NEW: content/changelog/2026-10-16-<next-id>.mdx not edited (website repo) — recorded as a cross-repo follow-up
f043 stale_content on-call on-call/channel/create-edit.mdx 创建向导的严格聚合行补上关闭时的同一约束

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/rum/error-tracking/issue-status.mdx: the 手动更新状态 screenshot still shows a 4-entry dropdown — it needs a new asset (the prose now lists all 5 options)
  • Confirm the new <Update label="2026-10-16"> block reads well next to the unmerged 2026-10-15 block in PR docs: doc-review 2026-10-15 — AI console page actions, AI-assisted noise reduction, service-calendar/CLI/SDK drift #1057 (same insertion point, an expected conflict on merge)

Cross-repo follow-ups (flashduty-website)

  • NEW: content/changelog/2026-10-16-.mdx — flashduty-website has no changelog entry for the window's user-visible ships (IM-bound automations, RUM issue resolve mode / regression, IM member auto-linking); its newest pair of entries is dated 2026-10-05. Website entries are one dated .mdx plus a .zh.mdx sibling.

    • Suggested action: Cross-repo follow-up (not edited by this PR): add a website changelog pair for 2026-10-16 covering the same three capabilities as f200, in the existing dated-file + .zh.mdx form, with the marketing voice used by the neighbouring entries.
  • zh|en/openapi/api-catalog.mdx is stale (handed to the api-review automation, not edited here): it still says 「365 个接口」 and 「Monitors(41 个接口)」 and lists only /monit/folder/list, while api-reference/openapi.zh.json now has 370 paths / 46 Monitors paths and the six /monit/folder/* routes became app_key-callable this window. The catalog enumeration and api-reference/** are that automation's surface.

Mapping warnings

  • flashduty-docs → zh|en/on-call/quickstart/comparison.mdx (derivative_surfaces.comparison_page.paths): the product comparison pages actually live at zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx; the stale path silently disables the automatic comparison check, so this run checked those pages by hand instead
  • flashduty-docs → developer/mcp-server/ and developer/terraform/ (modules mcp-server and terraform, docs_path): the pages are files, not directories: zh|en/developer/mcp-server.mdx and zh|en/developer/terraform.mdx; set docs_path to the two-letter root ('developer/') or to the .mdx file
  • fc-foundation-app → every src/Packages/* path in the mapping (saas, monit, rum, ai-sre, meow-ui): these are git submodules; their URLs in .gitmodules are SSH and cannot be initialised in the cloud sandbox, so the run diffs the standalone sibling clones (fc-saas-web, fc-saas-monit, fc-saas-rum, ai-sre-web, ai-assistant-web) instead and reports paths in the mapping's src/Packages/... form — expected, not staleness

Skipped

  • None removed by a human reviewer (this run was fully automated).
  • Considered and deliberately not filed: zh/rum/error-tracking/issue-alerts.mdx 「Issue 重开」 row — the code does not contradict its wording (it never states the version condition), and the file is held by an open PR.

Notes for reviewers (code-side, not doc issues)

  • go-flashduty WriteDelete's generated comment claims deletion removes children/rules/dashboards, while the OpenAPI note for POST /monit/folder/delete says a non-empty folder returns 409 FolderNotEmpty. Two writers hit this; the docs follow the 409 behaviour.
  • fc-rum cmd/server/controller/issue/update.go defaults resolve_mode to any when a client sends status=resolved without the field, while the DB/migration default for issues is version. The console always sends it explicitly.
  • fc-event migration/wildcard/rewrite.go skips values whose only regex metacharacters are parentheses or a lone dot (e.g. x(y)*), so those values silently change from regex to literal matching after the switch.

…lve mode, IM member auto-linking, CLI/SDK drift

Window: 2026-10-15T08:00:13Z → 2026-10-16T08:12Z (previous successful run → this run).
28 findings from a diff-mode scan of 15 changed source repos + 5 submodule repos
(5 high / 17 medium / 6 low); 27 applied in the docs repo, 1 recorded as a
cross-repo follow-up for flashduty-website.

- ai-sre: automation rules gained a create-time-fixed execution location (Web/IM),
  the run_in API field, IM-run session-identity stripping, the third skipped cause,
  and the IM execution-environment exception; IM page gains the third trigger path;
  attachment accordion gains the image fitting/40 MP rules.
- on-call: removed aggregation-switch confirm dialog; literal wildcard matching +
  /.../ form and the stored-value migration; strict-grouping off-state rule
  (also on the channel wizard); DingTalk/Lark member auto-linking; Slack member
  linking removed from the docs because it never existed; new 2026-10-16 changelog
  block; comparison-page cells for IM-bound automations.
- rum: new issue resolve mode (any/version) and the corrected reopen conditions.
- cli / go-sdk: --run-in, --team-id inheritance, fixed-minute cron, install path and
  runner guard, monit folder-* commands, RuleFolders client, Automation run_in/TeamID.

mint broken-links: success, no broken links found.
@ysyneu

ysyneu commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Superseded by #1070, which re-applies the still-relevant parts of this PR on current main (see the table there for what was ported and what was left out).

@ysyneu ysyneu closed this Oct 17, 2026
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