Repository navigation
docs(doc-review): 2026-10-20 diff audit — 13 gaps fixed (routing FAQ, fan-in window, share cap, rule-table entries) - #1086
Merged
Conversation
…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.
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-20
Mode: diff (since
2026-10-19T08:01:17Z, until2026-10-20T08:07:00Z)Findings: 13 total — 0 high, 7 medium, 6 low
Automated incremental audit (
doc-review, diff mode, scopeall) over 23 repos. Window boundariesresolved with
git rev-list --first-parent -1 --before=<cutoff>on each repo'sorigin/main, so onlycommits that actually landed on the trunk inside the window are in scope.
Changes
on-call/integration/alert-integration/routing-rules.mdxon-call/statuspage/subscriptions.mdxplatform/permission-design.mdxai-sre/artifacts.mdxai-sre/automations.mdxai-sre/sessions.mdx.csv/.tsv) and video/audio rows to the in-session preview tableon-call/channel/escalation-rule.mdxon-call/channel/escalation-rule.mdxon-call/channel/noise-reduction.mdxon-call/channel/create-edit.mdxai-sre/artifacts.mdxai-sre/artifacts.mdxai-sre/environments.mdx,ai-sre/agents.mdxAll 22 changed files are
zh/+en/pairs.zh/written first,en/derived from it.Review checklist
Focus for reviewers, in order of risk:
partial-match co-delivery to the default route is the intended product behaviour and not a bug
(
fc-eventlogic/route/route.go:265NeedsDefaultRoute,cmd/engine/controller/preprocess/route.go).fc-pgylogic/role/role.go:154skipping non-enabled rows ingrantedPermissionIDs, used by boththe authorization path and the permission-factor list.
it invalidates came from the 2026-09-22 doc-review PR. Worth confirming 60 minutes is the shipped value.
ErrShareTooLargeandshareObjectByteCapare gonefrom
fc-safarilogic/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 againstzh/changelog/changelog.mdxand themodule 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_pagepoints atzh|en/on-call/quickstart/comparison.mdx, which doesnot exist. The real comparison pages are
zh|en/on-call/comparison/vs-pagerduty.mdxandvs-opsgenie.mdx. Consequence: the product-comparison derivative check is silently skipped everyrun — a clean run is not evidence that the comparison page is current.
mcp-server(developer/mcp-server/) andterraform(developer/terraform/)docs_pathvalues aredirectories that do not exist; the pages are
zh|en/developer/mcp-server.mdxandzh|en/developer/terraform.mdx. Those two modules are therefore never cross-referenced automatically.fc-foundation-appsubmodule paths (src/Packages/{saas,monit,rum,ai-sre,ai-assistant}) cannot bediffed in a cloud sandbox — the
.gitmodulesURLs are SSH andsrc/Packages/ai-kitis not fetchable.This run instead diffed the sibling repos
fc-saas-web,fc-saas-monit,fc-saas-rum,ai-sre-web,ai-assistant-webdirectly, reporting findings under themapping.yamlrepo/path spelling.Skipped
canvas.jsonmanifest schema (ai-sre/artifacts.mdx). The entry filename,view,boards(1–255,x/y/w/h≤ 20000),notesand the无法显示画布error path are agent-authoredartifact 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.tsxhint 「未被认领且未恢复」 — this is a product UI defect, not doc drift: thebackend filters inhibit matches on active status only, with no claimed condition, and
noise-reduction.mdxalready says 「无论是否已被认领」 correctly. Same wrong tooltip pre-existed inEditSuppressionRule.tsxat BASE. Worth a UI ticket, not a docs edit.api-reference/*.openapi.{zh,en}.json— no findings this round; those artifacts are owned by theapi-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.
fc-saas-rum/fc-saas-monit/fc-saas-webdashboards (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).