Skip to content

docs(doc-review): 2026-10-20 diff audit — 13 gaps fixed (routing FAQ, fan-in window, share cap, rule-table entries) - #1086

Merged
ysyneu merged 1 commit into
mainfrom
doc-review/20261020T081845Z
Oct 20, 2026
Merged

ysyneu merged 1 commit into
mainfrom
doc-review/20261020T081845Z

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 20, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-20

Mode: diff (since 2026-10-19T08:01:17Z, until 2026-10-20T08:07:00Z)
Findings: 13 total — 0 high, 7 medium, 6 low

Automated incremental audit (doc-review, diff mode, scope all) over 23 repos. Window boundaries
resolved with git rev-list --first-parent -1 --before=<cutoff> on each repo's origin/main, so only
commits that actually landed on the trunk inside the window are in scope.

Changes

Finding Type Module Doc Action
f001 feature_drift integration on-call/integration/alert-integration/routing-rules.mdx Documented that a name-mapping label value may list several workspaces (comma-separated, deduped, max 100); corrected the FAQ answer that claimed the default route never fires once a rule delivered — with multiple names and only a partial match it now co-delivers
f002 feature_drift statuspage on-call/statuspage/subscriptions.mdx Replaced the Note describing the deleted "update the pending subscription" behaviour: a re-submit while a confirmation is pending is a no-op (first submitted scope wins), a confirmed subscriber must re-confirm a scope change
f003 feature_drift platform platform/permission-design.mdx Effective permissions are the union of enabled roles only; disabling a custom role now revokes its permissions immediately while keeping member bindings
f004 config_drift ai-sre ai-sre/artifacts.mdx Removed the Note claiming artifacts over 16 MiB cannot get a public link — the share byte cap no longer exists
f005 config_drift ai-sre ai-sre/automations.mdx AI-analysis fan-in window corrected 10 → 60 minutes (both occurrences)
f006 missing_coverage ai-sre ai-sre/sessions.mdx Added table (.csv/.tsv) and video/audio rows to the in-session preview table
f007 stale_content on-call on-call/channel/escalation-rule.mdx Copy entry point: no more card icon — More actions (⋯) row menu; noted the enable/disable/delete menu states and confirmation dialogs
f008 missing_coverage on-call on-call/channel/escalation-rule.mdx Documented the third status-dot state 「当前不在生效时间」 (enabled but outside its effective window)
f009 stale_content on-call on-call/channel/noise-reduction.mdx Silence-rule copy entry moved to the row More actions menu; kept the quick-silence exclusion
f010 stale_content on-call on-call/channel/create-edit.mdx Exclusion-rule create button renamed 添加排除规则 → 新增规则
f011 feature_drift ai-sre ai-sre/artifacts.mdx Card thumbnails now also render tables, video and canvas/slides; only PDF and audio stay blank
f012 missing_coverage ai-sre ai-sre/artifacts.mdx Documented canvas board stepping (←/→, Previous/Next, Esc, counter) and the extra slide paging controls (PageUp/PageDown, Home/End, Shift+Space, swipe, click-half in Present)
f013 missing_coverage ai-sre ai-sre/environments.mdx, ai-sre/agents.mdx An A2A delegation on a BYOC runner now survives a reconnect and a console-instance restart; only cloud-environment delegations die with their instance

All 22 changed files are zh/ + en/ pairs. zh/ written first, en/ derived from it.

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

Focus for reviewers, in order of risk:

  1. f001 changes a definitive FAQ answer and adds a multi-name example — please confirm the
    partial-match co-delivery to the default route is the intended product behaviour and not a bug
    (fc-event logic/route/route.go:265 NeedsDefaultRoute, cmd/engine/controller/preprocess/route.go).
  2. f003 is a permissions page. The claim "disabling a role revokes immediately" rests on
    fc-pgy logic/role/role.go:154 skipping non-enabled rows in grantedPermissionIDs, used by both
    the authorization path and the permission-factor list.
  3. f005 — the 10 → 60 minute change was made in code inside this same window, and the doc sentence
    it invalidates came from the 2026-09-22 doc-review PR. Worth confirming 60 minutes is the shipped value.
  4. f004 deletes a Note rather than rewording it. ErrShareTooLarge and shareObjectByteCap are gone
    from fc-safari logic/artifact/gallery_share.go, so there is no cap left to describe.

Cross-repo follow-ups (flashduty-website)

None. The seven website changelog entries added this window
(2026-10-14-341203 … 2026-10-19-341208) were checked against zh/changelog/changelog.mdx and the
module pages; every distinctive claim (investigation-entry caps and defaults, filter wildcard semantics,
the 5/minute test-send limit, RUM custom dashboards, IM scan-to-connect, multi-file/canvas/slides
artifacts) is already covered on the docs side.

Mapping warnings

  • derivative_surfaces.comparison_page points at zh|en/on-call/quickstart/comparison.mdx, which does
    not exist. The real comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and
    vs-opsgenie.mdx. Consequence: the product-comparison derivative check is silently skipped every
    run
    — a clean run is not evidence that the comparison page is current.
  • mcp-server (developer/mcp-server/) and terraform (developer/terraform/) docs_path values are
    directories that do not exist; the pages are zh|en/developer/mcp-server.mdx and
    zh|en/developer/terraform.mdx. Those two modules are therefore never cross-referenced automatically.
  • fc-foundation-app submodule paths (src/Packages/{saas,monit,rum,ai-sre,ai-assistant}) cannot be
    diffed in a cloud sandbox — the .gitmodules URLs are SSH and src/Packages/ai-kit is not fetchable.
    This run instead diffed the sibling repos fc-saas-web, fc-saas-monit, fc-saas-rum, ai-sre-web,
    ai-assistant-web directly, reporting findings under the mapping.yaml repo/path spelling.

Skipped

  • Canvas/slide canvas.json manifest schema (ai-sre/artifacts.mdx). The entry filename, view,
    boards (1–255, x/y/w/h ≤ 20000), notes and the 无法显示画布 error path are agent-authored
    artifact internals. The docs repo's stated convention is to describe what users see rather than agent
    internals (commit aa13678c), so this was deliberately not written into the public page.
  • SuppressionDetail.tsx hint 「未被认领且未恢复」 — this is a product UI defect, not doc drift: the
    backend filters inhibit matches on active status only, with no claimed condition, and
    noise-reduction.mdx already says 「无论是否已被认领」 correctly. Same wrong tooltip pre-existed in
    EditSuppressionRule.tsx at BASE. Worth a UI ticket, not a docs edit.
  • api-reference/*.openapi.{zh,en}.json — no findings this round; those artifacts are owned by the
    api-review automation, which has its own open PR (docs(api-reference): api-review 2026-10-20 — document high_cardinality on RUM fields #1085). No doc-review edits were made to them.
  • Chart-library migrations in fc-saas-rum / fc-saas-monit / fc-saas-web dashboards (echarts →
    meow-ui, theme JSONs removed, legend components moved into the shared library) were checked against the
    existing chart docs and change no user-configurable surface, so no findings.

Validation

mint broken-links → success no broken links found (Node 20, mint 4.2.1072).

…6-10-20 diff audit

Incremental review of code merged between 2026-10-19T08:01:17Z and
2026-10-20T08:07Z across 23 repos. 13 findings applied (7 medium, 6 low):

- routing: name mapping now splits the label value on commas (up to 100
  names) and co-delivers to the default route when only some names match,
  which falsified the default-route FAQ answer
- statuspage: the pending email subscription is no longer rewritten on
  re-submit; the old Note described deleted behaviour
- platform: effective permissions are the union of ENABLED roles only
- ai-sre: AI-analysis fan-in window widened 10 → 60 minutes
- ai-sre: the 16 MiB public-share ceiling was removed
- ai-sre: session file preview gained video/audio/table kinds; canvas and
  slide viewers gained navigation controls; card thumbnails cover more kinds
- on-call: rule lists became tables, so the copy entry point, the
  out-of-window status dot and the exclusion-rule create button all changed

Verified with `mint broken-links`: no broken links.
@ysyneu
ysyneu merged commit 30e54ca into main Oct 20, 2026
1 check passed
@ysyneu
ysyneu deleted the doc-review/20261020T081845Z branch October 20, 2026 08:43
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