Skip to content

docs: daily doc-review 2026-09-01 — heartbeat, AI SRE status page drafts, IM feedback + drift fixes - #334

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/20260901-091033
Open

docs: daily doc-review 2026-09-01 — heartbeat, AI SRE status page drafts, IM feedback + drift fixes#334
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/20260901-091033

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 1, 2026

Copy link
Copy Markdown

Doc Review — 2026-09-01

Mode: diff (since 2026-08-31T08:12:03Z)
Findings: 21 total — 3 high, 10 medium, 8 low (17 module findings + 2 derivative changelog findings merged from 24 raw; 2 duplicate statuspage_draft / artifacts / heartbeat / images findings merged)

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre zh/en/ai-sre/sessions.mdx Added 状态页更新草稿 section: statuspage_draft tool, draft card fields/states, review handoff URL contract
f002 missing_coverage ai-sre zh/en/ai-sre/artifacts.mdx Added 视图切换与排序: card/list toggle, list table columns, server-side sort (default updated_at desc)
f003 missing_coverage monitors zh/en/monitors/explore/explore.mdx Added 行内隐藏 switch for common fields in log result view
f004 missing_coverage on-call zh/en/on-call/channel/escalation-rule.mdx Noted alias auto-prefix with source team name for other-team webhooks
f005 config_drift on-call zh/en/on-call/incident/search-view-incident.mdx Fixed 处理进度 default: 全部 → 未关闭 (Triggered/Processing)
f006 missing_coverage on-call zh/en/on-call/incident/search-view-incident.mdx Added batch-selection limit of 100 with rejection notice
f007 config_drift on-call zh/en/on-call/incident/handle-update-incident.mdx Updated console snooze path: 更多(⋮) → 暂缓 submenu, Processing-only
f008 missing_coverage on-call zh/en/on-call/incident/handle-update-incident.mdx Added 暂缓/升级/重新分派 rows to 更多操作 table with visibility conditions
f009 missing_coverage integration zh/en/.../standard-alert.mdx Added 静默检测 (heartbeat) section: enabled/timeout_minutes 10–2880/auto_recover
f010 missing_coverage integration zh/en/.../email.mdx Noted Alert Key regex must be valid RE2, rejected at save
f011 missing_coverage integration zh/en/.../email.mdx Added 静默检测 section
f012 missing_coverage integration zh/en/.../wecom-alert.mdx Added 静默检测 + RE2 validation note
f013 config_drift integration zh/en/.../wecom-alert.mdx Added RE2 regex validity note (extract_pattern)
f014 missing_coverage integration zh/en/.../flashcat.mdx Added 静默检测 section
f015 config_drift integration zh/en/.../routing-rules.mdx Updated Edit History UI: sidebar → dialog with dual-version compare
f016 config_drift integration zh/en/.../standard-alert.mdx Removed images from field-mapping whitelist; noted payload-only
f017 missing_coverage webhooks zh/en/.../jira-sync.mdx Noted required mapping rows (Key/结果字段/Jira优先级)
f018 missing_coverage ai-sre zh/en/ai-sre/sessions.mdx (merged into f001) latest-reply API surface described within status page draft section
f019 missing_coverage ai-sre zh/en/ai-sre/im.mdx Added /feedback section: rate/comment AI SRE replies in IM, per-rater storage
f020 missing_coverage derivative zh/en/changelog/changelog.mdx Added 2026-09-01 Update entry: heartbeat、状态页草稿、IM 反馈评价
f021 missing_coverage derivative flashduty-website Cross-repo follow-up, not edited here

Review checklist

  • Verify config field names and defaults match current code (heartbeat: enabled/timeout_minutes/auto_recover; RE2 validators)
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs

Cross-repo follow-ups (flashduty-website)

  • f021: flashduty-website content/changelog/ latest entry is 2026-08-11; 静默检测/AI SRE 状态页草稿/IM 反馈 none are listed. Add a dated entry (.mdx + .zh.mdx) for 2026-09-01.

Mapping warnings

  • monit-webapi / monit-edge: repo not found on GitHub (404 for flashcatcloud, flashcat, n9e orgs) — module monitors backend signals unverified this run. Suggest checking repo names/visibility.

Skipped

  • None (all 24 raw findings either applied or merged as duplicates: statuspage_draft×3 → f001/f020, artifacts sort×2 → f002, heartbeat standard-alert×2 → f009, images×2 → f016)

…RE status page drafts, IM feedback, and 17 doc-drift fixes
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.

0 participants