Repository navigation
docs: doc-review 2026-10-13 — war-room automation trigger, IM switch removal, alert-rule Go templates, CLI/SDK drift - #1048
Merged
Conversation
added 2 commits
October 13, 2026 09:20
![flashduty[bot]](https://github.githubassets.com/images/gravatars/gravatar-user-420.png){kind=avatar}
…removal, alert-rule Go templates, CLI/SDK drift
Diff mode, window 2026-10-12T08:00:37Z .. 2026-10-13T08:11Z. 20 findings (2 high, 10 medium, 8 low) applied across 23 zh + 23 en files.
See .doc-review/findings-2026-10-13-081100.{yaml,json,html} for the full findings (gitignored; attached to the automation run).
…w, quickstart, AI SRE landing) The war-room diagnosis finding's evidence cross-references these pages: they all still promised the preliminary diagnosis as an unconditional result of creating a war room. Reworded to the automation-rule framing (War room created trigger, requiring an enabled rule that matches the incident's channel and severity), consistent with ai-sre/im.mdx, on-call/advanced/war-room.mdx and the comparison pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Review — 2026-10-13
Mode: diff (since 2026-10-12T08:00:37Z, the previous successful run)
Findings: 20 total — 2 high, 10 medium, 8 low
Window: 12 source repos with changes (fc-event, ai-sre-web, fc-saas-web, fc-saas-monit, fc-saas-rum, fc-safari, flashduty-runner, flashduty-cli, go-flashduty, monit-webapi, monit-edge, fc-rum); 9 unchanged (fc-datasource, fc-oncall, fc-pgy, fc-statuspage, flashduty-app, flashduty-mcp-server, terraform-provider-flashduty, flashduty-website, and the fc-foundation-app superproject — its submodule packages are covered through the standalone submodule clones).
Changes
ai-sre/automations.mdxwar_room_created) with its 协作空间 / 严重程度 conditions, API field table (war_room_trigger_enabled/war_room_channel_ids/war_room_severities), IM-group session note, execution-environment rule, and thewar_room_initial_analysispreset template; updated every trigger enumeration on the pageai-sre/im.mdx,ai-sre/overview.mdx,ai-sre/quickstart.mdx,ai-sre.mdxoverview.mdx,quickstart.mdx, the AI SRE landing page), which all still promised the diagnosis as an unconditional result of creating a war room.../instant-messaging/{slack,lark,dingtalk,wecom}.mdxon-call/advanced/war-room.mdxai-sre/automations.mdxexecution_place,IM/Web 控制台) and its fallback rule, bumped the 触发类型 filter to six options, addedwar_room_createdto thetrigger_kindvalue listai-sre/automations.mdxai-sre/automations.mdxdeveloper/cli.mdx--max-data-pointsand--preserve-builtin-variablesonmonit dashboard-runtime-queries-resolvedeveloper/cli.mdx--since/--untilwindow cap foralert listandalert-event list, as already stated forincident list/change listdeveloper/cli.mdxautomation runs --trigger-kindvalue list (schedule/debug/manual/http_post/oncall_incident/war_room_created) and explainedwar_room_createddeveloper/cli.mdx--datastderr warning for fields unknown to the installed CLI versiondeveloper/go-sdk.mdx*ListIncidentsResponse→ the real*IncidentListResponse; audited every other response type named on the pagedeveloper/go-sdk.mdxclient.Sessions.Info→client.Sessions.ReadInfodeveloper/go-sdk.mdxclient.Dashboardsandclient.RuleFoldersrows (table now matchesgenServices1:1 at 39 rows)monitors/alert-rules/prometheus.mdx(+ 7 datasource pages){{ $labels.<label> }}in 关联查询 / 恢复查询: which three field kinds accept it (never main queries), the mixed-syntax rejection,$labels-only context, the function whitelist, dotted labels viaindex, and the monit-edge ≥ v0.75.4 save gate; one clause added to the other six datasource pagesmonitors/alert-rules/prometheus.mdxrender related queryrule-context error, query skipped; recovery expressions with{{render per instance)rum/sdk/{web,ios,android}/data-collection.mdxgeo.province/geo_provincerow to the three SDK geo attribute tableschangelog/changelog.mdx<Update label="2026-10-13">block with both features of this window (war-room trigger + IM switch removal; Go template in alert-rule queries)on-call/comparison/{vs-pagerduty,vs-opsgenie}.mdxmonitors/alert-rules/mysql.mdx${label_name}nor Go template is accepted; added the reason in proseAll 20 findings were applied; none were skipped or failed. Both languages changed for every file (26 zh + 26 en files, +314 / −104 across two commits:
94351dd0the main pass,1cfed726completing f002's cross-referenced pages).Review checklist
ai-sre/automations.mdx,ai-sre/im.mdx,ai-sre/overview.mdx,ai-sre/quickstart.mdx,ai-sre.mdx,on-call/advanced/war-room.mdx, the four IM integration pages and the two comparison pages (nine files, edited by independent passes — the phrasing is intentionally the same everywhere: the diagnosis is driven by an enabled automation rule with the War room created trigger that matches the incident's channel and severity)Cross-repo follow-ups (flashduty-website)
None. The derivative pass checked all four registered surfaces:
content/changelog/) — no entry for either feature, but this surface publishes in curated batches and lags: the docs changelog's2026-09-30and2026-10-09blocks (dashboard time variables, RUM analytics, MCP OAuth, CLI--timezone, RUM code repositories) have no website counterparts either, so "must have an entry" could not be established mechanically. Flagged for a product decision, not filed as a finding.content/andmessages/returns zero hits. (The pre-existing "60+" vs the site's own 267-alert/41-change numbers is out-of-window and not filed.)Mapping warnings
derivative_surfaces.comparison_page.paths=zh|en/on-call/quickstart/comparison.mdx— neither file exists;on-call/quickstart/holds onlyfaq.mdx,mobile-app.mdx,quickstart.mdx. The real comparison pages arezh|en/on-call/comparison/vs-pagerduty.mdxandvs-opsgenie.mdx(plus an unregisteredzh|en/on-call/statuspage/comparison.mdx). This round's comparison check was run against the real paths (f019), but untilmapping.yamlis fixed that derivative check silently does nothing.fc-eventpaths are missingcmd/server/controller/war_room,cmd/server/routes.goandlogic/incident_trigger_subscription— the path filter therefore dropped the decisive half of this window's fc-event change (war-room creation no longer starting the analysis; the newPOST /ai-sre/war-room/turnroute). The repo really changed 60 files; the filtered diff had 23. Evidence was recovered with an explicitgit diff <base> <head> -- <path>. Suggested: addlogic/incident_trigger_subscriptionto theon-callmodule and the twocmd/serverpaths toai-sre.fc-foundation-app's mapped paths are git submodules. Submodule URLs in.gitmodulesare SSH form and the container has no ssh client, sogit clone --recurse-submodulesfails partway; the analysis used standalone clones of the submodule repos (fc-saas-web→src/Packages/saas,fc-saas-monit→src/Packages/monit,fc-saas-rum→src/Packages/rum,ai-sre-web→src/Packages/ai-sre) and reports paths in the mapping's form. No URL was rewritten and no environment-specific file was added to the repo.mapping.yamlhas no entry for the runner/CLI-adjacent surfaces touched this window beyond the existingai-sre/cli/go-sdkmodules — no missing path, listed for completeness.Skipped
geo_provinceexample inzh|en/rum/explorer/data-query.mdx(part of f017's suggested action). Open PR docs(rum): describe Ask AI in the explorer and fix the device type example #1026 touches the same example block in both files; the province field is fully documented in the three SDK pages, so the example was left for that PR's author to fold in.war_room_initial_analysiscarriesenabled: falseinfc-safari/etc/automation_templates/*.yml, but that flag is catalog metadata —ai-sre-webautomationTemplateToPrefillforces the prefilled draft toenabled: trueand comments that the template's flag is "not the new rule's state". The docs therefore say nothing about a default enabled state.{{ $labels.<label> }}template gate is registered asFeatureAlertRuleQueryExprTemplate = v0.75.4inmonit-webapi/pkg/edgecompat/catalog.go; the docs state the version requirement as a save-time rejection on all matched monit-edge instances.fc-safari/etc/automation_templates/zh-CN.yml:name: 作战室初步分析/en-US.yml:War room initial analysis). The string 「作战室初诊」 appears only inai-sre-websrc/pages/Automations/helpers.test.tsfixtures, never in the UI —helpers.test.tsis test-only, so it is not used as a source of truth.Follow-ups found while fixing, not actionable in docs
flashduty-clihelp text is stale (source fix, not a docs fix):internal/cli/automation.go:436printsTrigger kind filter: schedule, debug, or http_postand:438registers completion for only those three, while the server'sListRunsRequest.TriggerKindoneof accepts six (… manual http_post oncall_incident war_room_created).registerEnumFlag(internal/cli/completion.go:12) only wires completion and does not validate, so the newer values work — the help string and completion list should be widened. This round's docs (f010) state the correct six.dashboard-panel-preview's--max-data-pointshelp omits the "omit or send null for the server default of 100" clause thatpanel-runandruntime-queries-resolvecarry (zz_generated_dashboards.go).alertsection paragraph atzh:688/en:693, which sits inside PR docs: doc-review 2026-10-12 — RUM auto-analysis, AI SRE IM attachments, CLI --fields, incident/integration/monitors drift #1045's~684-700region. If docs: doc-review 2026-10-12 — RUM auto-analysis, AI SRE IM attachments, CLI --fields, incident/integration/monitors drift #1045 also lands a window note foralert list/alert-event list, the merged page may state the 31-day rule twice — worth one pass when resolving that conflict.