Skip to content

Doc Review 2026-10-09 — dashboard time variables & display time zone, RUM Explorer analytics, MCP/Go-SDK OAuth, CLI --timezone - #1034

Merged
ysyneu merged 1 commit into
mainfrom
doc-review/2026-10-09-082137
Oct 9, 2026
Merged

ysyneu merged 1 commit into
mainfrom
doc-review/2026-10-09-082137

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 9, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-09

Mode: diff (since 2026-10-08T08:07:17Z, the previous successful run)
Findings: 28 total — 5 high, 15 medium, 8 low
Applied: 25 (25 doc findings + 1 derivative changelog) · Deferred to api-review: 1 · Skipped: 1 (see below) · Cross-repo follow-up: 1

Window scanned across 24 repos/submodules. Zero-commit repos in this window (verified base == head against the remote ref, with a positive control at an earlier timestamp): fc-oncall, fc-datasource, terraform-provider-flashduty, flashduty-app, fc-statuspage, flashduty-runner, monit-edge, fc-pgy (commits present, none in mapped paths), ai-assistant-web, meow-ui.

Changes

Finding Type Module Doc (zh + en) Action
f001 stale_content cli developer/cli.mdx Rewrote the 「时区语义」 Warning: automation create/update now both take --timezone; added it to the create parameter table and the update modifiable-field list; documented the omit → member/account/Asia/Shanghai chain, the explicit-empty → UTC case, and that update recomputes schedule_next_fire_at_ms
f011 missing_coverage cli developer/cli.mdx Added alert list --alert-ids/--alert-keys/--asc/--by-updated-at and alert-event list --asc
f020 missing_coverage cli developer/cli.mdx Documented incident comment --comment-type-id in the 评论类型 section
f021 missing_coverage cli developer/cli.mdx Listed incident feed <id> with --asc / --types
f022 missing_coverage cli developer/cli.mdx Added the INSTALLED_NAME row and the renamed-binary behaviour
f023 missing_coverage cli developer/cli.mdx Added a runtime environment-variable table (FLASHDUTY_BASE_URL, FLASHDUTY_NO_UPDATE_CHECK, …)
f002 missing_coverage go-sdk developer/go-sdk.mdx New 「OAuth 访问令牌」 section for NewClientWithAccessToken; corrected the Tip that claimed app_key is the only credential
f012 missing_coverage go-sdk openapi/go-sdk.mdx Same capability, second SDK page; corrected its Tip
f003 missing_coverage mcp-server developer/mcp-server.mdx Added the remote OAuth sign-in path (credential-less connector, browser consent) and the 认证(远程,OAuth)row
f013 missing_coverage mcp-server developer/mcp-server.mdx New 「OAuth 授权与发现」 subsection: oauth: prefix, 401 + WWW-Authenticate, the three /.well-known/oauth-protected-resource endpoints
f024 missing_coverage mcp-server developer/mcp-server.mdx Added the base_url remote query parameter (APP-key only)
f004 missing_coverage monitors monitors/dashboards/dashboards.mdx New 「内置时间变量」 subsection: $__interval / $__rate_interval / $__range / $__auto, rendered values, datasource × query-mode availability matrix
f016 missing_coverage monitors monitors/dashboards/dashboards.mdx Documented the time picker's 显示时区 row (常用项, continent-grouped list, localStorage persistence, absolute-vs-relative behaviour)
f025 config_drift monitors monitors/dashboards/dashboards.mdx Added the reserved __ prefix to the variable-naming rule
f026 missing_coverage monitors monitors/dashboards/dashboards.mdx Loki Query-variable field must be a stream label name; candidates come from label values over the dashboard time range
f014 missing_coverage monitors monitors/explore/explore.mdx New 「内置时间变量」 section for Workbench Prometheus/Loki queries, incl. the instant-query failure modes and the 「图表 + 原始」half-failure case
f005 missing_coverage rum NEW rum/explorer/analytics.mdx (+ docs.json nav in both languages, + cards in rum/explorer/overview.mdx) New page for the Explorer analytics view: aggregations, group/field selectors, five chart types, drill-down, zoom, PNG/CSV export, pie and distribution constraints, sampling badge, URL parameters
f017 config_drift rum rum/quickstart/app-management.mdx Rollout 「采用情况」 rewritten: waffle grid + version share table, the four stats, the 更早版本 grouping, 查看明细 → 查看会话明细, 查看配置/收起配置
f018 missing_coverage rum rum/quickstart/app-management.mdx Documented the 「允许远程配置」 switch (default on) and added remoteConfigurationEnabled to the miniprogram field table and sample code
f006 config_drift ai-sre ai-sre/im.mdx Corrected the ack-receipt emoji pools (Lark: Typing/THINKING/Get/OnIt; DingTalk: 思考/收到/Get) and stated the pool's intent
f008 config_drift ai-sre ai-sre/automations.mdx Rewrote the 「时区」 Warning: the zone is a field in the schedule card for all cadence modes, defaulting to the member's resolved zone
f009 missing_coverage ai-sre ai-sre/automations.mdx Documented the schedule-replacement warning (pending run dropped, next run recomputed, up to 5 min late)
f010 stale_content ai-sre ai-sre/memory.mdx Removed 新建记忆 and 类型 from the editable fields — the page only edits name/description/content
f019 missing_coverage ai-sre ai-sre/mcp.mdx Added the Client ID Metadata Document fallback for authorization servers without DCR
f027 missing_coverage derivative changelog/changelog.mdx Added the 2026-10-09 <Update> block for this window's shipped features

Review checklist

  • Verify config field names and defaults match current code (especially the built-in time-variable availability matrix and $__rate_interval arithmetic in monitors/dashboards/dashboards.mdx)
  • Check that feature descriptions accurately reflect user-facing behaviour — the new rum/explorer/analytics.mdx page is entirely new and the largest addition here; please read the chart/drill-down semantics against a real Explorer session
  • Confirm the developer/mcp-server.mdx OAuth section describes the flow you want customers to follow (the MCP OAuth story is told across the deployment tabs and a new subsection)
  • Ensure tone and style match the rest of the docs
  • Sanity-check the new 2026-10-09 changelog block: it is a public announcement and lists four feature groups

Cross-repo follow-ups (flashduty-website)

  • f028 — website changelog. The website changelog's newest entry is content/changelog/2026-10-05-341202.mdx; nothing covers the features shipped on 2026-10-08/09 that this round documents (dashboard built-in time variables + display time zone, RUM Explorer analytics, MCP/Go-SDK OAuth, CLI --timezone). Suggested action: publish a dated .mdx + .zh.mdx pair for the same window. Not edited by this PR (different repository).

Not a finding, checked by hand: lib/integrations/catalog.ts in flashduty-website changed in this window, but it is a pure reorder — 346 entries before and after with identical id sets — so no catalog entry was added or removed and the 「267 alert / 41 change integrations」 claims still hold (re-counted against fc-datasource:structs/plugin.go on origin/main).

Mapping warnings

  • derivative_surfaces.comparison_page.paths in .claude/skills/doc-review/mapping.yaml points at zh|en/on-call/quickstart/comparison.mdx, which does not exist. The real comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx. This is the 6th consecutive round this entry has been silently skipped by the skill; the comparison check was therefore run by hand against the real directory this round, and both pages' Flashduty-side 「267 集成源」 cell still matches the registry count. The fix belongs in the skill's mapping.yaml, not in the docs repo — flagging it here again because it cannot be fixed from this PR.

Skipped

  • f007 — alert-rule investigation_targets (排障落点). The capability is real: monit-webapi model/alert_rule.go:51 carries InvestigationTargets []types.InvestigationTarget, with a save-time Edge version gate in logic/alert_rule_investigation_edge_gate.go. It is not written into the docs, for two reasons: (1) the feature dates from commit ed524bd on 2026-09-02, i.e. it is not a change in this window — the only in-window signal was the rewrite of the agent-facing reference card fc-safari:logic/runtime/bootstrap/skills/flashduty/reference/monit-rule.md; and (2) it has no console surface — git grep investigation over fc-foundation-app/src/Packages/monit/pages on origin/main returns nothing, so documenting it inside monitors/quickstart/quickstart.mdx (a walkthrough of the five form blocks) would describe a control that does not exist. It is reachable only through the rule API/CLI body. Decision needed from the docs owner: whether the API/CLI-only surface should be documented at all, and if so where. Not applied rather than guessed at.

…ay time zone, RUM Explorer analytics, MCP/Go-SDK OAuth, CLI --timezone
@ysyneu
ysyneu merged commit ca399e1 into main Oct 9, 2026
2 checks passed
@ysyneu
ysyneu deleted the doc-review/2026-10-09-082137 branch October 9, 2026 08:35
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