Skip to content

docs(doc-review): daily review 2026-10-26 — RUM AI SRE query dock, per-application dashboards, error-location grouping - #1133

Merged
ysyneu merged 3 commits into
mainfrom
doc-review/2026-10-26T081000Z
Oct 26, 2026
Merged

ysyneu merged 3 commits into
mainfrom
doc-review/2026-10-26T081000Z

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Doc Review — 2026-10-26

Mode: diff (since 2026-10-23T08:13:07Z — previous successful run; window end 2026-10-26T08:13Z)
Findings: 26 total — 3 high, 17 medium, 6 low · applied 19 · held 3 · skipped (already carried by an open PR / duplicate) 4

Repos scanned in the window: fc-event, fc-pgy, fc-rum, monit-webapi, fc-safari, flashduty-cli, go-flashduty, fc-foundation-app (+ fc-saas-rum, ai-sre-web submodules), flashduty-docs. Repos with zero commits in the window were skipped (fc-oncall, flashduty-app, fc-datasource, monit-edge, fc-statuspage, flashduty-mcp-server, terraform-provider-flashduty, flashduty-runner, fc-saas-web, fc-saas-monit, ai-assistant-web, meow-ui).

Changes

Finding Type Module Doc Action
f001 · rum-front missing_coverage rum rum/explorer/data-query.mdx Added 「用 AI SRE 查询和分析」 (dock, status line, undo, stop/collapse, credits fallback) and reframed the page as 用 AI 查询 with the basic panel as the non-AI-SRE path
f002 · rum-front feature_drift rum rum/explorer/data-query.mdx Rewrote 追加而非替换 → 在现有查询上继续改 (append vs replace, 替换查询 button, struck-through old query)
f003 · rum-front stale_content rum rum/explorer/data-query.mdx Removed the promise of an undo toast after apply; undo now points at 撤销修改 in the AI SRE dock
f004 · rum-front config_drift rum rum/analytics/custom-dashboards.mdx Tabs list only the current application's dashboards; app switch, foreign link, clone rules
f005 · rum-front stale_content rum rum/analytics/custom-dashboards.mdx Dropped the panel 应用 selector and 跟随页面应用; $app documented as a legacy stored value only
f006 · rum-front stale_content rum ai-sre/sessions.mdx RUM 查看器 added as a third page with page actions, with its different confirmation model
f007 (f001) feature_drift rum rum/analytics/custom-dashboards.mdx Rewrote 应用与时间范围 / 面板查询 / 看板变量 for the one-application rule and the $app rejection on save
f008 (f002) feature_drift rum rum/explorer/data-query.mdx Same section as f002 (append vs replace), merged
f009 (f003) missing_coverage rum rum/explorer/data-query.mdx Added count preview, 0-result auto-rewrite, step trail, and the analysis-question hand-off to AI SRE
f010 (f004) missing_coverage rum rum/analytics/custom-dashboards.mdx New limits row: 16 concurrent data queries per account, queueing and timeout behaviour
f011 (f001) feature_drift rum rum/error-tracking/error-aggregation.mdx Location joins the default fingerprint; similarity merging confined to one location; iOS crashes added to fingerprint-only list; Tip on pre-existing Issues
f014 (f002) feature_drift ai-sre ai-sre/sessions.mdx turn_in_flight vs is_running in the queue section, status table and API section
f015 (f001) missing_coverage on-call on-call/incident/alert-management.mdx Title filter: case-sensitive substring, wildcard//regex forms, 7-day window and its error
f016 (f002) stale_content on-call on-call/comparison/vs-pagerduty.mdx Flashduty-side 检索能力 cell narrowed to what the list filters actually do
f017 (f003) missing_coverage on-call on-call/incident/search-view-incident.mdx Label / custom-field list filters are exact match; wildcard syntax belongs to rule filters
f021 (f001) missing_coverage cli developer/cli.mdx --war-room-trigger / --war-room-channel-ids / --war-room-severities and the update toggles documented
f023 (f003) missing_coverage go-sdk developer/go-sdk.mdx War-room trigger fields on the SDK request/item structs (pointer-vs-value, validation, read-back)
f024 (f001) feature_drift monitors developer/go-sdk.mdx Missing X-DSID / old edge now returns 200 with empty Prometheus data instead of text/plain

Extra, outside the finding list: the 2026-10-19 changelog entry still described the per-panel application / $app model that this window removed — that clause now carries a one-line correction pointing at the new rule (zh + en).

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
  • Reader-fit deletions removed only mechanism, never a limit, default, or behavior the reader relies on

Validation run in this PR (22 files, zh + en each):

  • mint broken-links: success no broken links found in the files that parsed, skipped 36 file(s) — the same 36 MDX parse errors that a clean origin/main produces (compared file-by-file with a worktree of origin/main, sets identical), all in on-call/integration/alert-integration/alert-sources/*.
  • zh/en heading counts match on every edited pair; no docs.json or path changes, so no redirects are needed.

Held (needs a decision before documenting)

Finding Doc Why held Evidence
f013 / f020 (fc-safari, fc-event) ai-sre/im.mdx The IM config-repair turn (chat_settings-only turn that fixes a chat's team scope / pinned environment in natural language) is behind deploy.aiSreNlSettings, which the code documents as Default false: enabling this is a deliberate rollout decision; no console or CLI entry invokes it. Flag off ⇒ behaviour is exactly what the docs already say. Do not write it until the flag is on for customers. fc-event config/config.go:117-122; fc-event etc/deploy.yml:14 is the dev/test file (localhost endpoints); fc-saas-web pages/IntegrationCenter/detail/Source/IM/components/AISRESettings.tsx renders no control for it
f026 (fc-pgy) platform/quickstart.mdx (new) The onboarding API (`/onboarding/state items

Skipped

Finding Why
f018 (event-aisre) — third IM switch 允许 AI 主动接话 + /ambient Already carried by open PR #1129 (`zh
f019 (event-aisre) — 「默认均为开启」 on IM integration pages lark.mdx and slack.mdx are already fixed by #1129; 钉钉 / 企业微信 do not render the off-by-default ambient switch, and microsoft-teams.mdx does not make the claim
f022 (cli) — escalate-rule-reorder Already documented by #1129 in `zh
f025 (ai-sre-web) — page-embedded AI SRE chat surface Duplicate of f001/f006: the dock does have a host (fc-saas-rum pages/SessionsExplorer mounts AISREPanelWrapper + AiSreDock.tsx), so the surface is documented from the RUM side instead
f012 (rum-issue-session) — dSYM note on rum/error-tracking/error-reporting/ios.mdx Premise corrected, not a docs gap: grouping runs at ingest on the stack exactly as the SDK sent it (cmd/engine/controller/event/error.go → logic/issue/group.go); dSYM symbolication is a read-path enrichment only (sole caller of Processor.Enrich is cmd/server/controller/sourcemap/enrich.go:49). Uploading dSYM changes how the stack reads, not the fingerprint. The reader-visible half (an unresolved frame is keyed image + offset, stable within one build) is covered by f011 on the aggregation page.

Non-findings checked and dropped deliberately: monit-webapi execution-history storage refactor (same event_name, fields and query; console limits live in fc-saas-monit constants and still match the docs); fc-event Mongo→PG dual-store/shadow-guard work (internal; the only reader-facing changes are f015–f017); fc-rum cache/interval/workload-group plumbing and session-stat recompute (no documented freshness/granularity/quota claim); go-flashduty / flashduty-cli generated OpenAPI files (owned by the api-review automation); fc-safari actor/inflight/refactor internals.

Cross-repo follow-ups (flashduty-website)

  • Website changelog (content/changelog/): no entry for the two RUM releases in this window. Latest entry is 2026-10-19-341207; add a dated pair covering (1) RUM Explorer query box now docks an AI SRE conversation and (2) a custom dashboard belongs to one application. Same facts as the docs changelog entry added in this PR — zh/changelog/changelog.mdx, <Update label="2026-10-25">.
  • No new or changed alert-source integration in this window, so the integrations catalog and the integration-count claims are unaffected.

Mapping warnings

  • fc-foundation-app: mapping.yaml addresses the frontend packages as src/Packages/<pkg>/..., which does not exist on disk in a standalone clone — analysed from fc-saas-rum / ai-sre-web / fc-saas-web (repo root == package root). Still unfixed on the skill side.
  • derivative_surfaces.comparison_page points at zh|en/on-call/quickstart/comparison.mdx, which does not exist (the comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx) — the automated comparison pass is silently skipped every round; this round's comparison edit (f016) was found by the on-call batch, not by that pass.
  • mcp-server / terraform module docs_path are directories that do not exist (developer/mcp-server/, developer/terraform/); the real files are zh|en/developer/mcp-server.mdx and terraform.mdx, so those modules are never cross-referenced automatically.

Notes for reviewers

  • zh/rum/explorer/data-query.mdx is the biggest rewrite: the page was restructured into 用 AI 查询 → 用 AI SRE 查询和分析 / 基础自然语言查询, keeping every existing syntax section below untouched.
  • Generated API reference (api-reference/**) is untouched: turn_in_flight and RUM dashboard application_id reach the OpenAPI specs through the api-review PR docs(api-reference): daily api-review 2026-10-26 — dashboard application_id, session turn_in_flight #1132, not through this PR.
  • Changelog entry is dated 2026-10-25, the day release/explorer-ai-query and feat/rum-dashboard-per-app merged in fc-saas-rum; adjust the label if the release actually ships on another date.

@ysyneu
ysyneu merged commit 559b8aa into main Oct 26, 2026
1 check passed
@ysyneu
ysyneu deleted the doc-review/2026-10-26T081000Z branch October 26, 2026 08:50
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