Repository navigation
docs: doc-review 2026-10-12 — RUM auto-analysis, AI SRE IM attachments, CLI --fields, incident/integration/monitors drift - #1045
Closed
flashduty[bot] wants to merge 3 commits into
Closed
flashduty[bot] wants to merge 3 commits into
flashduty[bot] wants to merge 3 commits into
Conversation
…s, CLI --fields, incident/integration/monitors drift Diff-mode doc review over the window 2026-10-09T08:13:26Z..2026-10-12T08:00Z (previous successful automation run..now). 27 findings, 16 medium / 11 low / 0 high; 25 applied to docs, 2 are flashduty-website cross-repo follow-ups. zh/ written first, en/ derived. mint broken-links: success, no broken links found.
…-actions section Consistency with the IM entry in the same block, which already links #附件与图片. Anchors verified present (zh:283 ### 头部操作, en:282 ### Header actions) and mint broken-links stays clean.
… and CLI wording - ai-sre/sessions.mdx (zh+en): drop the stale 'shows the type (Agent / A2A)' claim on the subagent line; the badge lives on the panel header. - ai-sre/agents.mdx (zh+en): related-pages teaser no longer calls the row a card. - developer/cli.mdx (zh+en): global-flags intro excepts --version (cobra registers it only on the root), and the truncation advice now points at the global --fields instead of the curated commands. mint broken-links: success, no broken links found.
This was referenced Oct 13, 2026
Contributor
|
Superseded by #1070, which re-applies the still-relevant parts of this PR on current main (see the table there for what was ported and what was left out). |
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-10-12
Mode: diff (since
2026-10-09T08:13:26Z, previous successful automation run → 2026-10-12T08:00Z)Repos: 19 source repos + submodules
fc-saas-web, fc-saas-monit, fc-saas-rum, ai-sre-web; zero commits inside the mapped paths forfc-oncall,fc-datasource,fc-pgy,monit-edge,fc-statuspageFindings: 27 total — 0 high, 16 medium, 11 low
Applied to this PR: 25 · Cross-repo follow-ups: 2 · Skipped: 0
Validation:
mint broken-links→success no broken links foundzh/was written first anden/derived from it; every claim below was read out of the source atorigin/mainbefore writing (no stubs or placeholders).Changes
ai-sre/agents.mdxai-sre/mcp.mdxai-sre/environments.mdxai-sre/im.mdxai-sre/im.mdxai-sre/im.mdxai-sre/agents.mdx,ai-sre/sessions.mdxsessions.mdx里「显示类型(Agent / A2A)」的旧表述一并纠正ai-sre/mcp.mdxai-sre/skills.mdxai-sre/sessions.mdxai-sre/automations.mdxon-call/incident/work-items.mdxon-call/incident/search-view-incident.mdxon-call/channel/integrate-data.mdxon-call/channel/integrate-data.mdxmonitors/dashboards/dashboards.mdxrum/error-tracking/error-viewing.mdxdeveloper/cli.mdxdeveloper/cli.mdxdeveloper/cli.mdxdeveloper/cli.mdxdeveloper/cli.mdxchangelog/changelog.mdxchangelog/changelog.mdxchangelog/changelog.mdxcontent/changelog/<new dated entry>.mdx (+ .zh.mdx)content/changelog/<new dated entry>.mdx (+ .zh.mdx)Review checklist
en/mirror of eachzh/page touchedCross-repo follow-ups (flashduty-website)
These two findings target
flashduty-websiteand are deliberately not edited by this PR.content/changelog/rum_issue_incident_analysisautomation template).mdx+.zh.mdxentry; the website changelog's latest entries are2026-10-05-341201/341202while the docs changelog runs to 2026-10-12content/changelog/Note on cadence: the docs changelog is ahead of the website changelog (2026-10-12 vs 2026-10-05), so this may
be a deliberate publishing cadence rather than a gap — a human owner of that repo should decide.
Mapping warnings
derivative_surfaces.comparison_page.pathsis stale. It points atzh|en/on-call/quickstart/comparison.mdx, which does not exist; the real product-comparison pages arezh|en/on-call/comparison/vs-pagerduty.mdxandzh|en/on-call/comparison/vs-opsgenie.mdx.Consequence: the skill's automated "product comparison needs a new row/cell" derivative check silently
skips every run. The fix belongs in the skill's
mapping.yaml, not in this repo. The comparison pages weretherefore checked manually this run — the AI SRE / On-call / Response sections are not invalidated by
any change in this window (the new
rum_issue_incident_analysistemplate does not falsify the open-ended"内置告警噪音分析、事故复盘、值班洞察等模板" cell), so no comparison edit is included.
origin/mainwith zero missing paths this run.ai-assistant-webhad 2 commits in the window but is not referenced bymapping.yaml, so no module ownsit and nothing was analyzed there.
Open questions for the reviewer
entry is only offered in the Flashduty SaaS deployment; that claim remains true for the catalog fallback it
describes (
IntegrationCatalog.tsxgates on!onPremises). But the new panel-side 提交集成需求 button,reached from the add-integration panel's empty state (
NoResults.tsx, invoked fromPluginList.tsx), hasno
onPremisesgate. This PR deliberately does not restate any deployment claim for that button — pleaseconfirm with the frontend owner whether on-prem is meant to show it, and adjust the sentence if so.
version, not the finding's wording):
f501: the incident timeline assignee rendering does not open the session.IWorkItem.tsxpassespeopletoCoauthorLinewithoutrenderAiAvatar, so only the card avatar (ActionRow.tsx) and theAI-action rows (
ActorLine.tsx) are hover-to-session triggers. The section documents the timeline as ajoint signature only.
f901: an unmatched--fieldsname is a fail-fast error only on the curated commands that declaretheir own
--fields; on the new global flag it is a stderr note. The rewritten section scopes theerror claim to the curated commands accordingly.
f904scoping.--versionis not inherited by subcommands (cobra registers it only whereVersionisset, and only the root sets it), so the global-flags intro explicitly excepts it; a few generated commands
define their own
--versionfor optimistic locking and keep their own meaning.zh|en/on-call/advanced/war-room.mdxshows the same two work-item timeline eventsin example form without the new 「指派给 …」 clause. Not touched here — the examples are illustrative rather
than claims, but it is the same class of staleness as
f502if you want it covered.Skipped
None — all 22 module findings were applied. Two derivative findings (
f1104,f1105) areflashduty-websitetargets and are listed under Cross-repo follow-ups instead of being edited here.
Derivative surfaces (this run)
2026-10-12block added (f1101–f1103); the previous newest label was2026-10-09.flashduty-websitediff in thiswindow was CSS-only (hero padding,
<header>max-width), no integration added or renamed and no count claimtouched, so no integration-catalog finding.