Skip to content

docs: doc-review 2026-10-15 — AI console page actions, AI-assisted noise reduction, service-calendar/CLI/SDK drift - #1057

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

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

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 15, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-15

Mode: diff — window 2026-10-14T08:01:57Z (last successful run) → 2026-10-15T08:00Z
Findings: 36 total — 4 high, 11 medium, 21 low

Source repos scanned (22): fc-event, fc-oncall, fc-foundation-app, flashduty-app, fc-datasource, fc-pgy, fc-rum, monit-webapi, monit-edge, fc-statuspage, flashduty-mcp-server, terraform-provider-flashduty, fc-safari, flashduty-runner, flashduty-cli, go-flashduty, flashduty-website, and the fc-foundation-app submodules fc-saas-web, fc-saas-monit, ai-sre-web, fc-saas-rum, ai-assistant-web.

Repos with no commits in the window: fc-oncall, flashduty-app, monit-webapi, flashduty-mcp-server, terraform-provider-flashduty, flashduty-runner, flashduty-website, ai-assistant-web.

Changes

Finding Sev Type Doc (zh + en) Action
f001 high missing_coverage on-call/channel/noise-reduction.mdx Added section 「让 AI 帮你配置降噪」: entry, prefilled /channel-noise request, 3-step flow, confirm-before-write, group/flapping-only scope
f002 high missing_coverage ai-sre/sessions.mdx Added section 「操作控制台页面」 under 工具调用与产物 (page-declared actions, park/resume, read vs write)
f003 high missing_coverage ai-sre/sessions.mdx Same section — backend runtime half: page manifests sent every turn, console-only, no fduty bypass on a form page
f004 high missing_coverage ai-sre/sessions.mdx Same section — page-side half (registered actions on 告警聚合 / 抖动检测, brand ring + 状态条)
f005 medium missing_coverage changelog/changelog.mdx Added the 2026-10-15 changelog entry; also corrected the 2026-10-14 dashboard-search wording
f006 medium missing_coverage on-call/configuration/service-calendar.mdx FAQ accordion: added the intra-calendar overwrite rule (one manual setting per day, latest write wins)
f007 medium missing_coverage on-call/integration/alert-integration/alert-sources/aliyun-dataworks-op.mdx Added ## 标签 label-mapping section to zh; corrected 6 inaccurate rows + added the empty-label/title facts to en
f008 medium stale_content monitors/alert-rules/investigation-entries.mdx Rewrote 预览跳转 for the two preview modes and documented the new 预览数据源 picker
f009 medium feature_drift monitors/dashboards/dashboards.mdx Renamed 全局搜索 → 搜索全部仪表盘 and rewrote the 弹窗 sentence as the inline drop-down
f010 medium missing_coverage monitors/dashboards/dashboards.mdx Added the 最近打开 bullet (5 items, browser-local, 清除记录)
f011 medium missing_coverage ai-sre/skills.mdx Added channel-noise to the 内置 Skill table plus a subsection on its entry-only trigger and write scope
f012 medium missing_coverage ai-sre/sessions.mdx Added the channel_noise entry to 上下文引用
f013 medium missing_coverage ai-sre/sessions.mdx Added the two-layer consent model (ask_user intent + per-save confirm card) to the new section
f014 medium missing_coverage developer/cli.mdx Added a curated ### calendar — 服务日历 subsection (range-clear delete, upsert trim, days resolved map)
f015 medium missing_coverage developer/go-sdk.mdx Added ### 服务日历事件 behaviour note (range clear, upsert carve, Days/CalDay layer precedence)
f016 low missing_coverage ai-sre/sessions.mdx Documented the channel_noise context reference (type, entry, prefilled question)
f017 low stale_content on-call/configuration/service-calendar.mdx Changed 新增日历 → 创建 (the button users actually see)
f018 low missing_coverage on-call/configuration/service-calendar.mdx Added the one-workday-minimum rule and the all-workdays-empty default to 批量标记休息日
f019 low missing_coverage on-call/configuration/service-calendar.mdx Added the current-language holiday filter and save-on-click behaviour to 关联节假日
f020 low missing_coverage on-call/configuration/service-calendar.mdx FAQ: added the day-cell ring and the layer/struck-through tooltip
f021 low missing_coverage on-call/channel/create-edit.mdx Added the page-size bullet (12/24/48/96, default 24, custom cap 100)
f022 low missing_coverage rum/quickstart/app-management.mdx Added a paragraph: query results are filtered by application read permission (50-app cap included)
f023 low config_drift monitors/alert-rules/investigation-entries.mdx Updated the 时间范围 default to 告警前 60 分钟 / 告警后 30 分钟
f024 low missing_coverage monitors/alert-rules/investigation-entries.mdx Added the dashboard-picker pre-list + remote title/description search sentence
f025 low missing_coverage monitors/folders/folders.mdx Added the 移动到其他分组 dialog description (search, disabled current folder, toasts)
f026 low feature_drift monitors/dashboards/dashboards.mdx Result rows no longer show the description — corrected to title + folder path
f027 low missing_coverage monitors/dashboards/dashboards.mdx Added the 128-character search-keyword row to 配额与限制
f028 low missing_coverage monitors/dashboards/dashboards.mdx Documented that the list page size is persisted in browser storage
f029 low stale_content monitors/explore/explore.mdx Corrected the result-view row counts and documented browser persistence of the row count
f030 low missing_coverage monitors/engine/engine-lost-alert.mdx Documented rows-per-page (and column) persistence — applied to engine-lost-alert, engine and data-sources
f031 low stale_content ai-sre/sessions.mdx Widened the 撤回排队消息 exclusion to function_response + function_responses; same fix in zh/en openapi/api-catalog.mdx
f032 low stale_content developer/cli.mdx Added the release_limited sentence to the oncall license-list description
f033 low missing_coverage developer/cli.mdx Documented the work-item status enum (create/update/complete/convert)
f034 low stale_content developer/cli.mdx Documented the Also in the response: line and the third output-bound class
f035 low stale_content developer/go-sdk.mdx Added the work-item status-enum note to the Go SDK behaviour list
f036 low missing_coverage rum/explorer/data-query.mdx Added the 字段:* (field exists / IS NOT NULL) row to the attribute-search table

Review checklist

  • Verify config field names, defaults and limits match current code
  • Check that feature descriptions accurately reflect user-facing behaviour
  • Ensure tone and style match the rest of the docs
  • Confirm each en/ file is a faithful translation of its zh/ counterpart (zh is the source of truth)

Cross-repo follow-ups (flashduty-website)

None. flashduty-website had no commits in this window. The integrations catalog (lib/integrations/catalog.ts, 346 entries) already lists aliyun-dataworks-op, and every "60+" integration-count claim in messages/zh.json / messages/en.json still holds.

Handed to the api-reference automation (api-review) — not edited here

api-reference/*.openapi.{zh,en}.json (split) and api-reference/openapi.{zh,en}.json (consolidated) are generated and owned by the api-review daily audit, so these two were reported rather than patched:

  1. POST /rum/data/query — the operation now enforces per-application read access and caps a request at 50 applications (fc-rum cmd/server/controller/data/access.go, maxApplicationsPerRequest = 50, called by data/query.go before any query runs). Its 限制说明 still says 「权限要求 无」 and lists only 400/401/429/500; 403/404 are now reachable and should be listed. (rum-api f001)
  2. RUM SQL validation rejects subqueries — fc-rum logic/ast/sql/sql.go (the subquery_test.go asserts refusal, not support). This is a newly rejected construct on the public sql field used by /rum/data/query and /rum/facet/count, and no API-reference or prose page documents the restriction. (rum-ast f001)

A third item, also api-reference-only: api-reference/on-call.openapi.{zh,en}.json still describes work-item target_status as "client-defined string — no fixed state machine", while the Go SDK and CLI now treat it as the closed enum open|in_progress|done|cancelled. The prose fix landed here (f033, f035).

Mapping warnings

None. All 97 mapped source paths in mapping.yaml resolve against origin/main, including the submodule-aware check for src/Packages/{saas,monit,rum,ai-sre,ai-assistant}. No repo was missing and none failed to clone.

Skipped

Two Phase-1 findings were dropped before the fix pass, and no Phase-2 worker returned a SKIPPED:

  • AI SRE welcome card names (zh|en/ai-sre/sessions.mdx): the docs list 「定时自动巡检」 as one of the four default scenario cards, but the code's fourth default is 「自动分析新故障」 and 定时自动巡检 lives in the 更多 dropdown. Real drift, but not introduced in this window — the diff only changed icon colour classes and the container width on that file — so it belongs to a backlog pass, not this PR.
  • /rum/data/query OpenAPI limits — moved into the api-review hand-off above instead of being edited inline.

Notes for the reviewer

  • One finding was corrected against the code during the fix pass. f025 originally claimed a same-named rule in the target folder surfaces as the 移动失败 toast. It does not: monit-webapi logic/logic_alert_rule.go MoveRule returns HTTP 200 with a per-rule message list, and the frontend only toasts 移动失败 when the request itself rejects. So the rule is silently skipped while 移动成功 still shows. The docs here state only that the rule is not moved — worth a product ticket, not a docs fix.
  • One colour claim was dropped as unverified. f020 suggested describing the new day-cell ring as 蓝色边框. ring-primary resolves to the brand purple token, not blue, so the text says 额外描一圈边框 without naming a colour.
  • Two existing changelog entries were corrected, because the code in this window moved under them: the 2026-10-14 dashboard entry still called the search a dialog named 全局搜索, and the 2026-10-14 调查入口 entry still said 预览跳转 always needs an active alert. Both are now accurate; no other dated entry was touched.
  • De-duplicated against open PR docs: doc-review 2026-10-12 — RUM auto-analysis, AI SRE IM attachments, CLI --fields, incident/integration/monitors drift #1045 at hunk level, not just file level. It edits ai-sre/sessions.mdx, ai-sre/skills.mdx, developer/cli.mdx, monitors/dashboards/dashboards.mdx and changelog.mdx — the same files this PR touches, but different sections (子代理汇报 / 子任务, 上传 Skill toolbar, 全局参数 table + alert events + 时间窗口提示, the 全屏与查询详情 panel hover, and the 2026-10-12 entry). Expect merge conflicts on those files; the content does not overlap.
  • mint broken-links → success no broken links found (re-run on the frozen tree).

…ise reduction, and service-calendar/CLI/SDK drift

Window: 2026-10-14T08:01:57Z (last successful run) → 2026-10-15T08:00Z.
36 findings across 22 source repos → 20 doc pages updated (zh + en).

Highlights:
- ai-sre/sessions: new 操作控制台页面 section (page-declared actions, park/resume,
  two-layer consent, read vs write) — previously undocumented everywhere.
- on-call/channel/noise-reduction: 「让 AI 帮你配置降噪」 entry and the channel-noise skill.
- ai-sre/skills: channel-noise added to the built-in skill enumeration.
- changelog: new 2026-10-15 entry; corrected the 2026-10-14 dashboard-search and
  investigation-entry wording that this window's code moved under.
- Developer: curated `calendar` subsection, release_limited, work-item status enum,
  third generated-output bound class, Go SDK service-calendar behaviour.
- Monitors / RUM / platform / DataWorks detail fixes.

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