Skip to content

docs(doc-review): daily incremental review 2026-09-24 — 9 findings (4 medium, 5 low) - #468

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-09-24-083111
Open

flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-09-24-083111

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 24, 2026

Copy link
Copy Markdown

Doc Review — 2026-09-24

Mode: diff (since 2026-09-23T08:02:03Z, the previous successful run)
Findings: 9 total — 0 high, 4 medium, 5 low

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre zh/ai-sre/sessions.mdx + en/ 筛选面板维度表新增 发起人(全部 / 我发起的 / 指定成员)一行,说明其仅在 范围 不是 个人 时出现、一次最多加载 50 名成员、不选成员等于不过滤;步骤标题同步改为「按范围 / 发起人 / 状态 / 活动筛选」
f002 stale_content ai-sre zh/ai-sre/insight.mdx + en/ 下一步建议改名并改写行为:Script-first automation rewrite → Tested-script automation rewrite,脚本改放到该自动化自己的知识库目录 knowledge/<scope>/automations/<slug>/,任务提示只留目标、交付方式与指向该目录的指引
f003 missing_coverage cli zh/developer/cli.mdx + en/ 工作项小节新增「负责人可以是成员,也可以是本账户的 AI SRE」三点:assignees(仅 --data 传、最多 20 项、与 --assignee-ids 互斥)、work-item-list --assignee-type person|ai_sre、assignee_ids 收窄为人员子集且新增 agent_session_id / agent_session_venue
f004 stale_content on-call api-reference/on-call.openapi.zh.json + .en.json 把窗口内已落到 consolidated spec 的 5 项 work-item 变更补进实际渲染的模块 spec:新增 WorkItemAssignee schema、CreateWorkItemRequest / ResetWorkItemAssigneesRequest / WorkItemItem 的 assignees、ListWorkItemRequest.assignee_type、WorkItemItem.agent_session_id / agent_session_venue,并同步 4 条 assignee 描述改为 AI SRE 口径
f005 missing_coverage ai-sre api-reference/safari.openapi.zh.json + .en.json SessionListRequest 补 person_ids(int64 数组,与 scope / team_ids 取交集);SessionItem 补 has_open_tasks(boolean,尽力而为,读取失败时不返回)
f006 missing_coverage derivative flashduty-website → lib/integrations/catalog.ts 不在 docs 内改动,见下方 Cross-repo follow-ups
f007 stale_content on-call/integration alert-sources/standard-alert.mdx、keep.mdx + en/ 标签值上限由「2048 个字符」改为「8192 字节(8 KB)」,并说明截断会回退到 UTF-8 字符边界;同页 description 的 2048 字符限制(按字符计)正确,未改动
f008 missing_coverage on-call/integration alert-sources/honeycomb.mdx + en/ 标签表补 source(固定为 honeycomb)
f009 missing_coverage on-call/integration alert-sources/honeybadger.mdx + en/ 标签表补 source(固定为 honeybadger)与 check(与告警标题一致)

Notes for the reviewer

  • No path changes. No .mdx was renamed or moved and no navigation entry changed, so no docs.json redirects are involved. docs.json is untouched: no new pages were created, and editing existing OpenAPI operations is picked up on reload without a pages allow-list change.
  • f004 severity/scope. The consolidated api-reference/openapi.{zh,en}.json was already updated in the window (docs commit a6db604, 2026-09-23T08:07:52Z). Per the api-review skill, Mintlify renders the per-module files and docs.json does not point at the consolidated copy — so the On-call API Reference tab was showing the pre-change, person-only assignee model. All 11 schema/property pairs are now byte-identical between the module and consolidated files, in both languages.
  • f007 is calibrated to low (the analyzer proposed medium). The number/unit on the label row is a minor detail; the mismatch also predates this window (maxLenOfLabel = 8 * 1024 is unchanged at the window base commit). It is included because the helper that implements label-value truncation, MaxByteLength, did change in this window (invalid-UTF-8 cut → rune-boundary back-off), so the truncation behaviour these two pages describe is in scope. The label-value constant is 8 * 1024 bytes while description uses MaxRuneLength at 2048 characters — do not "align" them.
  • f001 has two independent sources. The console filter UI (fc-foundation-app/src/Packages/ai-sre/src/components/SidebarFilter.tsx) and the backend field (fc-safari/cmd/api/sessions/sessions.go:623-626) both changed in the window; the finding lists both.

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

Cross-repo follow-ups (flashduty-website)

  • f006 — Checkly is missing from the website integrations catalog. flashduty-website:lib/integrations/catalog.ts lists 84 alert-sources entries but has no checkly entry, while Checkly is otherwise a first-class integration: zh/ and en/ alert-sources/checkly.mdx exist and are registered in docs.json, fc-datasource registers the checkly.alert plugin, and this window's fc-saas-web change added it to sourceLogoMap / sourceSmallLogoMap and to pages/IntegrationCenter/docs/{zh,en}/config.ts. Suggested action: add a checkly entry (category: "alert-sources", docsPath: "on-call/integration/alert-integration/alert-sources/checkly", bilingual name/blurb) and an icon under public/integrations/, or rely on the letter placeholder. Note this gap predates the window (Checkly landed 2026-09-23T06:51:25Z, before the 08:02:03Z window start); the window only completed the console-side wiring. No docs-side change required.
  • Not reported as findings, deliberately: the docs changelog (newest entry 2026-09-16) has no entry for the 9 alert sources that shipped 2026-09-15→09-23, and the website changelog content/changelog/ (newest entry 2026-08-11) is ~6 weeks behind the docs changelog. Both are systemic/curation decisions rather than window-specific drift, so no entry was invented. The comparison pages' integration-count and capability cells were re-checked and are not invalidated by this window (the "60+ 集成源" claim still holds), and no competitor-side cell was touched.

Mapping warnings

mapping.yaml paths were validated against every repo at origin/main — all configured source paths and doc paths exist. Four gaps materially reduced coverage and are worth fixing:

  1. derivative_surfaces.comparison_page points at zh/on-call/quickstart/comparison.mdx, which does not exist. The comparison pages now live at zh/on-call/comparison/vs-pagerduty.mdx and vs-opsgenie.mdx.
  2. fc-event / on-call/integration omits cmd/engine/controller/alert/ (one handler per vendor) and the route registrations in cmd/engine/routes.go / cmd/server/routes.go. 18 handler files changed in this window; the scoped diff was empty until those paths were added by hand.
  3. fc-datasource omits logic/data_source/ (plug_alert.go, plugin.go), cmd/datasource/controller/ and deploy/data_source_plugin_init.sql, where alert-source plugins are registered.
  4. fc-safari / ai-sre omits logic/tool/builtin/, logic/task/, logic/automation/, cmd/api/runtime/, model/session/, model/task/, types/ and etc/ — 18 of 74 changed files fell outside the mapped paths, including the agent's built-in tools and Automations.

Skipped

None — --auto mode, so no findings were removed by a human before the fix phase. Reviewed and deliberately not converted into findings: internal session-settle / task-lifecycle refactors, built-in tool plumbing (tool names and arguments unchanged), the safari_task_terminal_total metric, etc/llm.yml model retirements, IM park-on-background behaviour, i18n key hygiene across the AI SRE console, and the AI SRE home/ConceptDemo onboarding animations (presentational, no config/field/route surface).

Diff window 2026-09-23T08:02:03Z..2026-09-23T16:07Z (17 repos).
9 findings: 4 medium, 5 low (0 high).

- ai-sre/sessions.mdx: session filter panel gained the 发起人 (creator) dimension
- ai-sre/insight.mdx: next-step reco renamed to 'Tested-script automation rewrite'
- developer/cli.mdx: work items can now be assigned to AI SRE
- api-reference/on-call.openapi.*: port the 5 work-item AI-SRE schema changes into
  the per-module spec Mintlify actually renders
- api-reference/safari.openapi.*: add SessionListRequest.person_ids and
  SessionItem.has_open_tasks
- alert-sources/standard-alert.mdx + keep.mdx: label value limit is 8192 bytes, not
  2048 characters
- alert-sources/honeycomb.mdx + honeybadger.mdx: document the always-emitted
  source/check labels

This branch has not been deployed

No deployments
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