Repository navigation
docs: doc-review 2026-10-19 — WeCom hosted domain, Lark managed app, template send-test, RUM custom dashboards - #1078
Merged
Merged
Conversation
…template send-test, RUM custom dashboards, monit edge self-monitoring Window: 2026-10-16T08:12:21Z -> 2026-10-19T08:00Z, 30 findings (4 high / 20 medium / 6 low). 29 applied across 41 files (zh + en), 2 new pages registered in docs.json, 1 handed off to api-review. mint broken-links: success, no broken links.
Resolve the wecom.mdx conflict: the rewritten setup checklist keeps its own structure, and step 4 now lists the five SaaS trusted IPs the console shows as one pasteable line, plus the private-deployment egress IP case.
…e self-monitoring pages with the console and product behavior - Templates: describe preview notices, test-send prompts and native-table fallbacks with the console's own wording; fix which limits demote every table versus only the table over the limit; stable anchors; restrict the no-table-rendering list to the channels that show raw text - WeCom: use the console's English labels, drop internal mechanism wording, note hosted domains take no port - Feishu/Lark: show permission group titles instead of identifiers; note an App ID used by another account is refused - Teams, custom actions, custom forms: match console English labels and trim internals - RUM: grouping by view_url_path is a high-cardinality grouping; trim implementation detail from custom dashboards; promote a lone H3 - Monitors: MySQL read-only check wording; self-monitoring alert expressions per instance, never-synced rule sync case, anchored link - Changelog, permission design, CLI, session recall: wording and label fixes
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-19
Mode: diff — since
2026-10-16T08:12:21Z(previous successful run) · scopeall· window ends2026-10-19T08:00ZFindings: 30 total — 4 high, 20 medium, 6 low · 29 applied, 1 handed off, 1 skipped at analysis · 41 files changed (+1227 / −225), 2 new pages
mint broken-links→ success no broken links found (all files parsed).Changes
on-call/integration/instant-messaging/lark.mdx## 选择接入方式+ QR / Flashduty-managed app flow, 7-state status table, 升级为自动管理on-call/integration/instant-messaging/lark.mdx## 在飞书完成配置(5-step checklist, self-tick vs manual confirm, permission JSON)on-call/integration/instant-messaging/lark.mdxcard.action.triggeron-call/integration/instant-messaging/wecom.mdxWW_verify(6 numbered steps)on-call/integration/instant-messaging/wecom.mdxon-call/integration/instant-messaging/wecom.mdxon-call/integration/instant-messaging/microsoft-teams.mdxon-call/integration/webhooks/custom-actions.mdx## 编辑已保存的操作— masked secrets, retype-to-change, destination guardon-call/configuration/templates.mdx### 发送测试— channel matrix, 5 / min,[测试]marker, result + 9 error codes,POST /template/preview/sendon-call/configuration/templates.mdx### 表格转原生表格— switch + native table limits + 6 fallback reasonson-call/configuration/templates.mdx### 预览会提示什么— format, table counts, byte budget, notice codeson-call/configuration/templates.mdxon-call/configuration/custom-forms.mdx## 在 IM 里关闭故障— guide reply withclose=1link, Feishu ephemeral + toastrum/analytics/custom-dashboards.mdxrum/explorer/analytics.mdxrum/explorer/analytics.mdxrum/explorer/data-query.mdxrum/error-tracking/issue-status.mdxerror-viewing.mdx+ the 2026-10-16 changelog entry alignedplatform/permission-design.mdxmonitors/engine/self-monitoring.mdxmonitors/alert-rules/mysql.mdxmonitors/quickstart/quickstart.mdxai-sre/sessions.mdxsession_transcript+.history/layoutai-sre/skills.mdxsession_transcriptto theallowed-toolstool enumerationdeveloper/cli.mdxintegrationsubsection:******masking, retype-to-change, destination guardai-sre/im.mdxon-call/statuspage/create-manage-page.mdxchangelog/changelog.mdx<Update label="2026-10-19">with 5 feature subsectionschangelog/changelog.mdxNew pages are registered in
docs.jsonfor bothzhanden(rum/analytics/custom-dashboardsafterminiprogram;monitors/engine/self-monitoringafterengine-lost-alert). No path was renamed or moved, so no redirect is needed.Review checklist
origin/mainof the source repo, with the file quoted in the finding (see.doc-review/findings-2026-10-19-081500.htmlfor per-finding evidence)len(value) > FeishuTableMaxCellSizeinfc-event logic/template/markdown_table.go:212), not characters — changelog and page now agreezh/on-call/integration/webhooks/custom-actions.mdxlacks the TLS-verification steps thaten/has;zh/monitors/dashboards/dashboards.mdxsays 「控制台暂无回收站页面」 which is true for Monit but not for RUMCross-repo follow-ups
api-review (generated OpenAPI surface — do not hand-edit):
POST /template/preview/sendis missing fromapi-reference/on-call.openapi.{zh,en}.jsonand therefore fromopenapi/api-catalog.mdx. Route:fc-event cmd/server/routes.go:336(tmplG.POST("preview/send", template.PreviewSend)), handlercmd/server/controller/template/preview_send.go. The catalog page renders from the spec, so a hand-written row would be a broken link.POST /rum/field/listresponses now carry ahigh_cardinalityproperty (used by f016) — same generated-spec surface,api-reference/rum.openapi.{zh,en}.json.flashduty-website:
content/changelog/) has no entry newer than 2026-10-05, while the docs changelog now covers 10-12, 10-14, 10-15, 10-16 and 10-19. This window's features (RUM custom dashboards, template send-test + native tables, WeCom hosted access domain, Lark managed app) therefore have no website entry. Owner should decide whether to backfill.Mapping warnings
14 warnings, all from
mapping.yamlgoing stale against the repo layout. The load-bearing ones:fc-foundation-appsrc/Packages/{saas,monit,rum,ai-sre}are git submodules that are empty in a plain clone, so every frontend path in the mapping resolves to nothing. Repos must be mapped to the standalone clones:fc-saas-web→pages,fc-saas-monit→pages,fc-saas-rum→pages,ai-sre-web→src(repo root is the package — drop thesrc/Packages/<pkg>/prefix). This round was run that way and found 118 / 60 / 59 changed frontend files that the mapping would have hidden.fc-datasourceis mapped only tomodel/{dingtalk,slack,teams,wecom}+structs/plugin.go, i.e. vendor structs; all IM setup / authorize / bind logic lives incmd/datasource/controllerandlogic/data_sourceand had never been audited.deploy/migrationsis unmapped too.fc-event cmd/engine/controller/notifyis unmapped — it is exactly where the notification-template behaviour of f009/f010 lives.pages/Template(notification templates) has no module entry at all, althoughzh/on-call/configuration/templates.mdxis generated from it.fc-safari:logic/tool/builtin,logic/agent,types/promptsunmapped — this window's whole AI SRE user-visible delta (builtinsession_transcript, compaction recall note) landed there.fc-oncall:cron,queue,namingunmapped — duty / scheduled-notification timing lives there.fc-statuspage: onlylogic/mapped; the customer-facing domain serving path iscmd/server/controller/page/+deploy/k8s/.Skipped
appSettings.login.defaultType='ldap'/login.ldapAccountId: delivery configuration injected by the operator, not a console setting. Every other private-deployment KV (enableOncall,enableRum,rumIngestEndpoint, …) is likewise undocumented, so this is treated as a deliberate boundary. If product wants it public, it belongs inplatform/configure-sso.mdx; evidence:fc-foundation-app src/pages/LoginPage/const.ts:63-70,Situations/SSOLogin/index.tsx:109-136.MONIT_HOST.apidoes not wirelistTrash/restoreDashboard, so Monit really has no trash page — only RUM does);panel_config_invalidpanel state (no backend emits that reason yet);ConditionEditDialog「多个名称请使用英文逗号分隔」 copy, which no backend splits on (possible product bug, not a docs gap); meow-ui design-system churn;fc-pgy(test files only).