docs: doc-review 2026-09-30 (diff) — dashboards page, RUM repository linking, on-prem license reminders - #790
Open
flashduty[bot] wants to merge 2 commits into
Open
flashduty[bot] wants to merge 2 commits into
flashduty[bot] wants to merge 2 commits into
Conversation
added 2 commits
September 30, 2026 16:53
…linking, on-prem license reminders Daily incremental doc review for 2026-09-29T08:04:41Z → 2026-09-30T16:35Z against the mapped source repos. 11 findings (2 high, 5 medium, 4 low); 9 applied. - new page zh|en/monitors/dashboards/dashboards.mdx (+ docs.json nav in both languages) for the Monitors 仪表盘 surface, which had no page at all - RUM 应用 代码仓库 tab documented; 远程配置 account rollout gate corrected - Slack AISRE bot scope table gains files:read - on-prem License expiry reminders documented - two new session attributes for the RUM explorer - 2026-09-30 changelog entry - flagship change_key instance-scope caveat
…scope caveat f401: add the RUM issue detail entry (AI 修复) and the RUM 异常 capsule kind to the context-reference enumeration in zh|en/ai-sre/sessions.mdx, with the entry's pre-filled question. f501: flagsmith.mdx gains the one-integration-per-instance caveat its Unleash / Rundeck / Azure DevOps siblings carry (data.id is an audit-log entry id).
4 tasks
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-30
Mode: diff (since
2026-09-29T08:04:41Z)Findings: 11 total — 2 high, 5 medium, 4 low · applied 9, skipped 2
Window and method
Last successful run
2026-09-29T08:04:41Z→ this run2026-09-30T16:35Z. All 17 mapped repos werecloned/fetched and diffed against
origin/<default-branch>(never the local checkout); thefc-foundation-appsubmodules (saas,monit,rum,ai-sre) were initialised with their SSHURLs rewritten to HTTPS and diffed from inside the submodule, with
.gitmodulesrestoredafterwards. Test, spec, story, mock and snapshot files were filtered out of the diff set before
analysis — they were roughly half of the raw diff and carry no documentation signal.
Ten of the seventeen repos had in-window commits:
fc-event(418 commits / 218 files),fc-foundation-app(272 files),fc-datasource,fc-pgy,fc-rum,monit-webapi,fc-safari,flashduty-cli,go-flashduty,flashduty-website. The other seven (fc-oncall,flashduty-app,monit-edge,fc-statuspage,flashduty-mcp-server,terraform-provider-flashduty,flashduty-runner) had none. Each area was analysed by onepass against its own diff, then written per file;
mint broken-linkswas run after all edits andreports no broken links.
Changes
missing_coverage(+ cross-ref inzhmissing_coverage+docs.json`stale_contentmissing_coveragemissing_coveragemissing_coveragemissing_coveragemissing_coveragemissing_coverageEvidence for the two high findings
f201 — no dashboards page exists.
zh/monitorscontained only quickstart, data-sources,explore, entity-tree, engine, alert-rules, folders and faq;
find zh en -iname "*dashboard*"returned nothing and
docs.jsonhad no monit dashboards entry, while the console navigates(
src/routes/menus/monit.tsx:41-46, group 可视化 → 仪表盘, route/monit/dashboards) and thebackend registers the full family (
monit-webapi/router/router.go:99-114: create, get, outline,list, search, update, move, delete, trash list, restore, revisions list/get, variables resolve).
The page's measurable claims were checked against source before merge: 20 variables / 10 tabs /
10 sections per tab / 30 panels per tab / 100 per dashboard (
types/dashboard/validate.go:27-31),^[A-Za-z_][A-Za-z0-9_]{0,63}$variable names, version message ≤1024, the eight refresh choices,the 8 relative presets, and
PAGE_RUN_CONCURRENCY = 4.f101 — the repositories tab is real and undocumented.
fc-rum types/application.goaddsApplicationRepository{repo, subdir}/ApplicationRepositories(max 10, subdir ≤255, firstentry primary) and the console ships
pages/Apps/Detail/RepositorySettings.tsx; the tab is gatedif (menu.key === 'repositories' && !aiSreEnabled) return false. Neitherzh/rum/**noren/rum/**mentioned it (andzh/ai-sre/**never mentioned RUM at all). All console stringsquoted in the new section were taken verbatim from
pages/Apps/locales/{zh_CN,en_US}.json.Review checklist
doc-review/2026-09-29-080936) is still open and also editszh|en/rum/quickstart/app-management.mdxandzh|en/changelog/changelog.mdx— whoever merges second will need a rebaseCross-repo follow-ups (flashduty-website)
content/changelog/— no entry for the in-window launches; the newest entry is2026-08-11-341200. Two large batches shipped on 09-29/09-30 (46 alert sources, 9 changeintegrations) plus the RUM repository linking and the dashboards work, none of which has a
website changelog entry. (The docs-side changelog gap is fixed by f702 in this PR; the website
side is out of this repo's scope.)
messages/zh.json+messages/en.json— 23 strings claim "60+ 集成源 / 60+ nativeintegrations" while the site's own catalog now carries 171
alert-sourcesentries(
lib/integrations/catalog.ts) and the product registers 173event.alertplugin types(
fc-datasource/deploy/data_source_plugin_init.sql, up 46 in this window). The same "60+"figure appears in the docs comparison pages; see the skipped finding f701 below.
lib/integrations/catalog.tsorpublic/integrations/— the catalog andthe 60 new logos were updated in-window and the new sources all resolve to shipped pages.
Mapping warnings
The skill's
mapping.yamlis stale in five places. Full detail is in the findings file(
mapping_warnings:); summary:flashduty-docsderivative_surfaces.comparison_pagepoints at `zhfc-eventcmd/engine/controller/change,logic/change,model/changefc-datasourcelogic/data_sourceunmappedon-call/integration/{alert-integration,change-integration,instant-messaging}; today onlymodel/*andstructs/plugin.goare mapped, so Slack-side logic (slack_join.go,slack_scopes.go) is invisiblefc-pgylogic/onprem,logic/api,cmd/server/controller/wallet,logic/permission,model/mis,model/bill)flashduty-websitecontent/changeloghas no in-window entrySkipped
missing_coverage, monitors) —InvestigationTargetinmonit-webapigained anoptional
purposefield (≤512 bytes, single-line, not templated, excluded from duplicatedetection) that the
api-reference/monitors.openapi.{zh,en}.jsonspecs do not carry. Notapplied:
api-reference/is generated by the daily api-review automation, it is outside everymodule's
docs_path, and the consolidated specs are being edited by open PRs docs(api): daily audit 2026-09-29 — RUM remote-config error-session switches, channel filter UTF-8 note #581 / docs(api): daily audit 2026-09-30 — alert detail_url into the rendered on-call spec, RUM issue-detail team_id semantics #778 rightnow — hand-editing only the split monitors files would create exactly the split-vs-consolidated
drift that automation exists to prevent. Route it to the next api-review run.
config_drift, derivative) — the docs state "60+ 集成源" (both comparison pages)and "50+ 告警源原生支持" (
zh|en/home.mdx) while the product registers 173event.alertplugintypes and ships 176 alert-source pages. Not applied deliberately: the same figure appears in 23
website strings that this repo does not own, two open PRs (docs: weekly doc-review sync (2026-09-23) #460, docs(doc-review): 43 documentation fixes from the 2026-09-18 → 2026-09-22 diff audit #428) are already editing the
comparison pages, and the number is a product-marketing decision rather than a derived value —
raising it in six docs files alone would create a cross-surface inconsistency worse than the
understated figure. Needs a decision from whoever owns the integration count.
Not findings (checked and discarded)
Recorded here so the next run does not redo the work. All 46 new alert sources and all 22
PlugChange*plugin types already have zh and en pages indocs.json;change_statusincluding the new
Failedvalue is documented incustom-event.mdx; thego-sdk/ CLI generatedhelp diffs carry only that
Failedenum and neitherzh|en/developer/go-sdk.mdxnorcli.mdxenumerates statuses; the
monit-webapiclose-task round-robin and backlog counters are internalqueue plumbing with no doc claim;
fc-safari'sdeploy/sandbox, marketplace seed skills andmigrations are release tooling. Three out-of-window observations were deliberately not reported:
the
harmonyplatform's remote-config support, Explore's missing 保存到仪表盘 entry, and the可用额度formula inplatform/pricing.mdx— all predate2026-09-29T08:04:41Z.