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
Open
flashduty[bot] wants to merge 1 commit into
flashduty[bot] wants to merge 1 commit into
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
zh/ai-sre/sessions.mdx+en/zh/ai-sre/insight.mdx+en/knowledge/<scope>/automations/<slug>/,任务提示只留目标、交付方式与指向该目录的指引zh/developer/cli.mdx+en/assignees(仅--data传、最多 20 项、与--assignee-ids互斥)、work-item-list --assignee-type person|ai_sre、assignee_ids收窄为人员子集且新增agent_session_id/agent_session_venueapi-reference/on-call.openapi.zh.json+.en.jsonWorkItemAssigneeschema、CreateWorkItemRequest/ResetWorkItemAssigneesRequest/WorkItemItem的assignees、ListWorkItemRequest.assignee_type、WorkItemItem.agent_session_id/agent_session_venue,并同步 4 条 assignee 描述改为 AI SRE 口径api-reference/safari.openapi.zh.json+.en.jsonSessionListRequest补person_ids(int64 数组,与scope/team_ids取交集);SessionItem补has_open_tasks(boolean,尽力而为,读取失败时不返回)flashduty-website→lib/integrations/catalog.tsalert-sources/standard-alert.mdx、keep.mdx+en/2048个字符」改为「8192字节(8 KB)」,并说明截断会回退到 UTF-8 字符边界;同页description的 2048 字符限制(按字符计)正确,未改动alert-sources/honeycomb.mdx+en/source(固定为honeycomb)alert-sources/honeybadger.mdx+en/source(固定为honeybadger)与check(与告警标题一致)Notes for the reviewer
.mdxwas renamed or moved and no navigation entry changed, so nodocs.jsonredirects are involved.docs.jsonis untouched: no new pages were created, and editing existing OpenAPI operations is picked up on reload without apagesallow-list change.api-reference/openapi.{zh,en}.jsonwas already updated in the window (docs commita6db604, 2026-09-23T08:07:52Z). Per theapi-reviewskill, Mintlify renders the per-module files anddocs.jsondoes 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.low(the analyzer proposedmedium). The number/unit on the label row is a minor detail; the mismatch also predates this window (maxLenOfLabel = 8 * 1024is 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 is8 * 1024bytes whiledescriptionusesMaxRuneLengthat 2048 characters — do not "align" them.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
Cross-repo follow-ups (flashduty-website)
flashduty-website:lib/integrations/catalog.tslists 84alert-sourcesentries but has nochecklyentry, while Checkly is otherwise a first-class integration:zh/anden/alert-sources/checkly.mdxexist and are registered indocs.json,fc-datasourceregisters thecheckly.alertplugin, and this window'sfc-saas-webchange added it tosourceLogoMap/sourceSmallLogoMapand topages/IntegrationCenter/docs/{zh,en}/config.ts. Suggested action: add achecklyentry (category: "alert-sources",docsPath: "on-call/integration/alert-integration/alert-sources/checkly", bilingualname/blurb) and an icon underpublic/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.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.yamlpaths were validated against every repo atorigin/main— all configured source paths and doc paths exist. Four gaps materially reduced coverage and are worth fixing:derivative_surfaces.comparison_pagepoints atzh/on-call/quickstart/comparison.mdx, which does not exist. The comparison pages now live atzh/on-call/comparison/vs-pagerduty.mdxandvs-opsgenie.mdx.on-call/integrationomitscmd/engine/controller/alert/(one handler per vendor) and the route registrations incmd/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.logic/data_source/(plug_alert.go,plugin.go),cmd/datasource/controller/anddeploy/data_source_plugin_init.sql, where alert-source plugins are registered.ai-sreomitslogic/tool/builtin/,logic/task/,logic/automation/,cmd/api/runtime/,model/session/,model/task/,types/andetc/— 18 of 74 changed files fell outside the mapped paths, including the agent's built-in tools and Automations.Skipped
None —
--automode, 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), thesafari_task_terminal_totalmetric,etc/llm.ymlmodel 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).