Skip to content

docs: doc-review 2026-10-12 — RUM auto-analysis, AI SRE IM attachments, CLI --fields, incident/integration/monitors drift - #1045

Closed
flashduty[bot] wants to merge 3 commits into
mainfrom
doc-review/2026-10-12-080816
Closed

flashduty[bot] wants to merge 3 commits into
mainfrom
doc-review/2026-10-12-080816

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Doc Review — 2026-10-12

Mode: diff (since 2026-10-09T08:13:26Z, previous successful automation run → 2026-10-12T08:00Z)
Repos: 19 source repos + submodules fc-saas-web, fc-saas-monit, fc-saas-rum, ai-sre-web; zero commits inside the mapped paths for fc-oncall, fc-datasource, fc-pgy, monit-edge, fc-statuspage
Findings: 27 total — 0 high, 16 medium, 11 low
Applied to this PR: 25 · Cross-repo follow-ups: 2 · Skipped: 0
Validation: mint broken-links → success no broken links found

zh/ was written first and en/ derived from it; every claim below was read out of the source at
origin/main before writing (no stubs or placeholders).

Changes

Finding Type Module Doc Action
f201 feature_drift ai-sre ai-sre/agents.mdx 派发目标环境清单改为「曾连接过的 Runner」,不再只列在线
f202 feature_drift ai-sre ai-sre/mcp.mdx 跨环境 MCP 连接器的可用环境判定改为「曾连接过」
f203 missing_coverage ai-sre ai-sre/environments.mdx 保留变量表补 FLASHDUTY_CONSOLE_URL 一行
f301 config_drift ai-sre ai-sre/im.mdx 钉钉回执表情池去掉 Get(飞书行保留)
f302 missing_coverage ai-sre ai-sre/im.mdx 新增「附件与图片」小节:历史附件、每轮额度 5/3/3、20 MiB 与 HTTPS、约 5s 时间预算
f303 missing_coverage ai-sre ai-sre/im.mdx 飞书群顶层 @ 新开话题会话带入最近 10 分钟群消息
f401 stale_content ai-sre ai-sre/agents.mdx, ai-sre/sessions.mdx 对话流改为一行(机器人图标 + 已派发〈名〉),Agent/A2A 徽标移到面板标题;sessions.mdx 里「显示类型(Agent / A2A)」的旧表述一并纠正
f402 config_drift ai-sre ai-sre/mcp.mdx 右上角入口由两个变三个,补「从插件目录添加」与目录感知空状态
f403 missing_coverage ai-sre ai-sre/skills.mdx Skill 列表补「从插件目录添加」入口与空状态
f404 missing_coverage ai-sre ai-sre/sessions.mdx 新增「子代理汇报」可见性说明
f405 missing_coverage ai-sre ai-sre/automations.mdx 创建表单支持 ?template=&oncall_incident_channel_ids= 深链
f501 feature_drift on-call on-call/incident/work-items.mdx 新增「指派给 AI SRE」小节,负责人字段补 AI SRE 选项
f502 stale_content on-call on-call/incident/search-view-incident.mdx 事件类型对照表补「指派给 …」从句与联合署名规则
f601 config_drift on-call/integration on-call/channel/integrate-data.mdx 添加集成面板改为可折叠分类区块 + 查看全部 + 搜索命中高亮
f602 stale_content on-call/integration on-call/channel/integrate-data.mdx 全部集成目录:标题计数移到搜索框提示、卡片悬停改为 + 图标
f701 feature_drift monitors monitors/dashboards/dashboards.mdx 悬停动作「重试」→「刷新」并补语义(失败态重试保留)
f801 missing_coverage rum rum/error-tracking/error-viewing.mdx 新增「头部操作」小节(开启自动分析);issue-alerts 补 On-call 投递前提
f901 missing_coverage cli developer/cli.mdx 全局参数表补 --fields;重写「结构化输出的字段投影」并修正被推翻的句子
f902 config_drift cli developer/cli.mdx incident list / alert list 的 --since 条件默认 30d;补 alert list --active/--recovered
f903 missing_coverage cli developer/cli.mdx 新增「时间窗口提示」小节(STDERR 的 note: window …)
f904 missing_coverage cli developer/cli.mdx 全局参数表补 --version(并说明被同名子命令参数覆盖的情形)
f905 missing_coverage cli developer/cli.mdx 补 incident alerts 与 alert events 的分页参数
f1101 missing_coverage derivative changelog/changelog.mdx 更新日志新增 2026-10-12 块:RUM Issue 一键开启自动分析
f1102 missing_coverage derivative changelog/changelog.mdx 更新日志新增 2026-10-12 块:AI SRE 读取 IM 附件
f1103 missing_coverage derivative changelog/changelog.mdx 更新日志新增 2026-10-12 块:CLI 全局 --fields 字段投影
f1104 missing_coverage derivative content/changelog/<new dated entry>.mdx (+ .zh.mdx) cross-repo — (不写入本仓)建议 flashduty-website 更新日志补 RUM 自动分析条目
f1105 missing_coverage derivative content/changelog/<new dated entry>.mdx (+ .zh.mdx) cross-repo — (不写入本仓)建议 flashduty-website 更新日志补 AI SRE IM 附件条目

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
  • Spot-check the en/ mirror of each zh/ page touched

Cross-repo follow-ups (flashduty-website)

These two findings target flashduty-website and are deliberately not edited by this PR.

Surface Feature Suggested action
content/changelog/ RUM Issue 开启自动分析 (rum_issue_incident_analysis automation template) Consider a dated .mdx + .zh.mdx entry; the website changelog's latest entries are 2026-10-05-341201/341202 while the docs changelog runs to 2026-10-12
content/changelog/ AI SRE reading images/documents/audio from IM history Consider a dated entry describing it

Note on cadence: the docs changelog is ahead of the website changelog (2026-10-12 vs 2026-10-05), so this may
be a deliberate publishing cadence rather than a gap — a human owner of that repo should decide.

Mapping warnings

  • derivative_surfaces.comparison_page.paths is stale. It points at
    zh|en/on-call/quickstart/comparison.mdx, which does not exist; the real product-comparison pages are
    zh|en/on-call/comparison/vs-pagerduty.mdx and zh|en/on-call/comparison/vs-opsgenie.mdx.
    Consequence: the skill's automated "product comparison needs a new row/cell" derivative check silently
    skips every run. The fix belongs in the skill's mapping.yaml, not in this repo. The comparison pages were
    therefore checked manually this run — the AI SRE / On-call / Response sections are not invalidated by
    any change in this window (the new rum_issue_incident_analysis template does not falsify the open-ended
    "内置告警噪音分析、事故复盘、值班洞察等模板" cell), so no comparison edit is included.
  • All other mapped repo paths validate against origin/main with zero missing paths this run.
  • ai-assistant-web had 2 commits in the window but is not referenced by mapping.yaml, so no module owns
    it and nothing was analyzed there.

Open questions for the reviewer

  1. On-premises gate on the new panel-side empty state. The add-integration page still says the 提交需求
    entry is only offered in the Flashduty SaaS deployment; that claim remains true for the catalog fallback it
    describes (IntegrationCatalog.tsx gates on !onPremises). But the new panel-side 提交集成需求 button,
    reached from the add-integration panel's empty state (NoResults.tsx, invoked from PluginList.tsx), has
    no onPremises gate. This PR deliberately does not restate any deployment claim for that button — please
    confirm with the frontend owner whether on-prem is meant to show it, and adjust the sentence if so.
  2. Two finding summaries were corrected against the code while writing (the shipped docs carry the corrected
    version, not the finding's wording):
    • f501: the incident timeline assignee rendering does not open the session. IWorkItem.tsx passes
      people to CoauthorLine without renderAiAvatar, so only the card avatar (ActionRow.tsx) and the
      AI-action rows (ActorLine.tsx) are hover-to-session triggers. The section documents the timeline as a
      joint signature only.
    • f901: an unmatched --fields name is a fail-fast error only on the curated commands that declare
      their own --fields; on the new global flag it is a stderr note. The rewritten section scopes the
      error claim to the curated commands accordingly.
  3. f904 scoping. --version is not inherited by subcommands (cobra registers it only where Version is
    set, and only the root sets it), so the global-flags intro explicitly excepts it; a few generated commands
    define their own --version for optimistic locking and keep their own meaning.
  4. Adjacent, not changed: zh|en/on-call/advanced/war-room.mdx shows the same two work-item timeline events
    in example form without the new 「指派给 …」 clause. Not touched here — the examples are illustrative rather
    than claims, but it is the same class of staleness as f502 if you want it covered.

Skipped

None — all 22 module findings were applied. Two derivative findings (f1104, f1105) are flashduty-website
targets and are listed under Cross-repo follow-ups instead of being edited here.

Derivative surfaces (this run)

  • docs changelog — new 2026-10-12 block added (f1101–f1103); the previous newest label was 2026-10-09.
  • website changelog / website integrations — see Cross-repo follow-ups; the flashduty-website diff in this
    window was CSS-only (hero padding, <header> max-width), no integration added or renamed and no count claim
    touched, so no integration-catalog finding.

flashduty[bot] and others added 3 commits October 12, 2026 08:17
…s, CLI --fields, incident/integration/monitors drift

Diff-mode doc review over the window 2026-10-09T08:13:26Z..2026-10-12T08:00Z
(previous successful automation run..now). 27 findings, 16 medium / 11 low / 0 high;
25 applied to docs, 2 are flashduty-website cross-repo follow-ups.

zh/ written first, en/ derived. mint broken-links: success, no broken links found.
…-actions section

Consistency with the IM entry in the same block, which already links
#附件与图片. Anchors verified present (zh:283 ### 头部操作, en:282
### Header actions) and mint broken-links stays clean.
… and CLI wording

- ai-sre/sessions.mdx (zh+en): drop the stale 'shows the type (Agent / A2A)' claim
  on the subagent line; the badge lives on the panel header.
- ai-sre/agents.mdx (zh+en): related-pages teaser no longer calls the row a card.
- developer/cli.mdx (zh+en): global-flags intro excepts --version (cobra registers it
  only on the root), and the truncation advice now points at the global --fields
  instead of the curated commands.

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