Skip to content

docs: 状态页 Widget 文档 + changelog,修复 24 条文档漂移(doc-review 2026-08-11) - #256

Merged
ysyneu merged 1 commit into
mainfrom
doc-review/2026-08-11-024302
Aug 11, 2026
Merged

docs: 状态页 Widget 文档 + changelog,修复 24 条文档漂移(doc-review 2026-08-11)#256
ysyneu merged 1 commit into
mainfrom
doc-review/2026-08-11-024302

Conversation

@ysyneu

@ysyneu ysyneu commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Doc Review — 2026-08-11

Mode: diff (since 2026-08-06,上次执行 findings-2026-08-06-014513)
Findings: 24 total — 4 high, 11 medium, 9 low(全部修复,无跳过)

Changes

Finding Type Module Doc Action
f001 missing_coverage (high) statuspage zh/en/on-call/statuspage/widgets.mdx(新建)+ docs.json 新建嵌入组件(Widget)文档页:badge/banner 两种形态、控制台配置、嵌入代码与属性参考、行为说明、summary.json 公开 API。控制台「嵌入组件」设置页已硬编码链接此路径
f002 missing_coverage (high) statuspage zh/en/changelog/changelog.mdx 新增 <Update label="2026-08-11"> 状态页 Widget 发布条目
f003 missing_coverage (low) statuspage zh/en/on-call/statuspage/publish-events.mdx 补「消息支持的 Markdown 格式」小节(含 GFM 表格)
f001 附带 statuspage zh/en/on-call/statuspage/comparison.mdx 「展示与定制」表新增嵌入组件(Widget)行
f004 missing_coverage (high) monitors zh/en/monitors/entity-tree/entity-tree.mdx 新增「导入告警规则」:三种来源格式、1MB/100 条限制、预检状态、转换降级规则、同名冲突策略、默认停用
f005 missing_coverage (medium) monitors 同上 新增「批量管理规则」:多选上限 100、批量启停(活跃告警异步关闭)、导出规则包、单条开关
f006 missing_coverage (medium) monitors 同上 新增「规则名称与注解模板变量」参考(.EntityAlert.*$labels 等,以 monit-edge template_renderer.go 为准)
f007 missing_coverage (low) monitors 同上 「配置变更注意事项」补修改基础规则的影响预览确认
f008 missing_coverage (low) monitors zh/en/monitors/alert-rules/loki.mdx 补 LogQL 编辑器标签名/标签值自动补全说明
f009 missing_coverage (medium) on-call zh/en/on-call/channel/escalation-rule.mdx 故障筛选补「集成来源(首条告警)」条件,并修正条件键描述(「标签」例子经核实仍成立,保留)
f010 feature_drift (low) on-call zh/en/on-call/incident/alert-management.mdx 告警来源补点击跳转行为(monit 告警跳规则详情/实体树深链)
f011 missing_coverage (medium) rum zh/en/rum/quickstart/app-management.mdx 应用类型与 SDK 配置引导新增 Electron
f012 feature_drift (medium) rum zh/en/rum/error-tracking/source-mapping.mdx 符号平台列表新增 Electron(Breakpad .sym / Debug ID)
f013 config_drift (low) rum zh/en/rum/analytics/native.mdx UV 口径补 Electron(用 Web 看板但按匿名 ID 统计)
f014 missing_coverage (high) ai-sre zh/en/ai-sre/sessions.mdx 「上传附件」新增文件夹上传(入口、50 文件上限、校验与跳过清单、目录结构保留)
f015 feature_drift (medium) ai-sre zh/en/ai-sre/skills.mdx 市场安装改写为固定账户级(无归属选择、不可改归属、同名冲突规则)
f016 feature_drift (medium) ai-sre zh/en/ai-sre/mcp.mdx 删除「分别安装到不同团队」说法,补市场安装固定账户级例外
f017 missing_coverage (medium) ai-sre zh/en/ai-sre/knowledge.mdx 知识库补「选择文件夹上传」
f018 feature_drift (low) ai-sre zh/en/ai-sre/sessions.mdx 附件扩展名放宽说明(合法 UTF-8 按 text/plain 接收)
f019 missing_coverage (low) ai-sre zh/en/ai-sre/sessions.mdx 上下文引用类型补「监控对象」「服务拓扑」
f020 missing_coverage (low) ai-sre zh/en/ai-sre/artifacts.mdx 公开页 UGC 声明与反馈入口(按代码实际写为页面顶部)
f021 feature_drift (medium) cli zh/en/developer/cli.mdx 字段投影区分列表(截短)与 detail(超限报错点名最大字段)
f022 stale_content (low) cli zh/en/developer/cli.mdx OpenAPI 操作数 288 → 327
f023 missing_coverage (medium) go-sdk zh/en/developer/go-sdk.mdx 服务表补 ServiceMap / ErrorIngestionRules / IssuePresetSeverityRules / Resources / SessionReplay(另补既有缺口 Licenses)
f024 stale_content (low) go-sdk zh/en/developer/go-sdk.mdx 288 操作 / 32 服务 → 327 / 38

Review checklist

  • 所有配置字段名、默认值、上限均对照 origin/main 源码核实(各 finding 的 source.files)
  • 前后端口径不一致处以用户实际体验的前端为准(如文件夹上传 50 文件上限)
  • comparison.mdx 新增 Widget 行的 Atlassian Statuspage 单元格(「✅ 支持 Status embed」)依据其官方支持文档填写,请人工复核:https://support.atlassian.com/statuspage/docs/embed-status-updates-to-other-pages/
  • widgets.mdx 的嵌入代码示例与控制台「复制嵌入代码」输出逐字一致(源自 saas buildWidgetEmbedCode),可在控制台核对一遍

Cross-repo follow-ups (flashduty-website)

  • website changelog:状态页 Widget 发布需同步一条 website changelog(content/changelog/<slug>.mdx + .zh.mdx),内容可复用本 PR 的 docs changelog 条目。
  • integrations catalog 本窗口无新集成类型,无需动作。

Mapping warnings(已修复 skill 侧 mapping.yaml,非本仓库文件)

  • status-page-fe 未收录(Widget 前端实现所在仓库)→ 已加入 statuspage 模块
  • fc-statuspage 路径缺 cmd/server/controller(widget 控制器)→ 已补
  • statuspage FE 路径 pages/Dashboard → 实际为 pages/StatusPage → 已修正
  • mapping.yaml 缺 SKILL.md 引用的 derivative_surfaces 注册表 → 已补

Skipped

无(24 条 findings 全部修复)。

Doc-review diff run since 2026-08-06 (24 findings: 4 high, 11 medium, 9 low):

- statuspage: new widgets.mdx (zh/en) for the embeddable status widget
  (badge/banner web component + public summary.json API), changelog
  entry 2026-08-11, markdown-table support note, comparison row
- monitors: entity-tree rule import (Prometheus/Operator YAML), batch
  enable/disable + bundle export, template variable reference,
  rule-update impact preview, Loki LogQL autocomplete tip
- on-call: escalation rule filter adds first-alert integration
  condition; alert source links to producing monit rule
- rum: Electron app type in app management, source mapping, UV basis
- ai-sre: folder upload for session attachments and knowledge packs,
  marketplace installs pinned to account scope (skills + MCP),
  attachment extension whitelist relaxation, new context-ref kinds,
  public artifact UGC disclaimer
- developer: cli detail-projection oversize now errors (288 -> 327
  ops); go-sdk service table adds ServiceMap, ErrorIngestionRules,
  IssuePresetSeverityRules, Resources, SessionReplay, Licenses
  (288/32 -> 327/38)
@ysyneu
ysyneu merged commit 0c20240 into main Aug 11, 2026
1 check passed
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