Skip to content

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
mainfrom
doc-review/2026-09-30-165234
Open

flashduty[bot] wants to merge 2 commits into
mainfrom
doc-review/2026-09-30-165234

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 30, 2026

Copy link
Copy Markdown

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 run 2026-09-30T16:35Z. All 17 mapped repos were
cloned/fetched and diffed against origin/<default-branch> (never the local checkout); the
fc-foundation-app submodules (saas, monit, rum, ai-sre) were initialised with their SSH
URLs rewritten to HTTPS and diffed from inside the submodule, with .gitmodules restored
afterwards. 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 one
pass against its own diff, then written per file; mint broken-links was run after all edits and
reports no broken links.

Changes

Finding Type Module Doc Action
f101 missing_coverage rum `zh en/rum/quickstart/app-management.mdx(+ cross-ref inzh
f201 missing_coverage monitors NEW `zh en/monitors/dashboards/dashboards.mdx+docs.json`
f102 stale_content rum `zh en/rum/quickstart/app-management.mdx`
f301 missing_coverage on-call/integration `zh en/on-call/integration/instant-messaging/slack.mdx`
f401 missing_coverage ai-sre `zh en/ai-sre/sessions.mdx`
f601 missing_coverage platform `zh en/platform/pricing.mdx`
f702 missing_coverage derivative `zh en/changelog/changelog.mdx`
f103 missing_coverage rum `zh en/rum/explorer/data-query.mdx`
f501 missing_coverage on-call/integration `zh en/on-call/integration/change-integration/flagsmith.mdx`

Evidence for the two high findings

f201 — no dashboards page exists. zh/monitors contained only quickstart, data-sources,
explore, entity-tree, engine, alert-rules, folders and faq; find zh en -iname "*dashboard*"
returned nothing and docs.json had no monit dashboards entry, while the console navigates
(src/routes/menus/monit.tsx:41-46, group 可视化 → 仪表盘, route /monit/dashboards) and the
backend 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.go adds
ApplicationRepository{repo, subdir} / ApplicationRepositories (max 10, subdir ≤255, first
entry primary) and the console ships pages/Apps/Detail/RepositorySettings.tsx; the tab is gated
if (menu.key === 'repositories' && !aiSreEnabled) return false. Neither zh/rum/** nor
en/rum/** mentioned it (and zh/ai-sre/** never mentioned RUM at all). All console strings
quoted in the new section were taken verbatim from pages/Apps/locales/{zh_CN,en_US}.json.

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behaviour
  • Ensure tone and style match the rest of the docs
  • Note on conflicts: PR docs: doc-review 2026-09-29 (diff) — RUM error-session capture, Explore graph behaviour #577 (doc-review/2026-09-29-080936) is still open and also edits zh|en/rum/quickstart/app-management.mdx and zh|en/changelog/changelog.mdx — whoever merges second will need a rebase
  • Two writers glossed a Chinese product string into English where the product string itself is Chinese-only (the on-prem reminder email/SMS copy). Confirm that is the house style here
  • The new dashboards page places the 代码仓库-style tabs/panel details per the console; a reviewer may want to trim the 配额与限制 table if some rows are too implementation-flavoured

Cross-repo follow-ups (flashduty-website)

  1. content/changelog/ — no entry for the in-window launches; the newest entry is
    2026-08-11-341200. Two large batches shipped on 09-29/09-30 (46 alert sources, 9 change
    integrations) 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.)
  2. messages/zh.json + messages/en.json — 23 strings claim "60+ 集成源 / 60+ native
    integrations" while the site's own catalog now carries 171 alert-sources entries
    (lib/integrations/catalog.ts) and the product registers 173 event.alert plugin 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.
  3. No action needed on lib/integrations/catalog.ts or public/integrations/ — the catalog and
    the 60 new logos were updated in-window and the new sources all resolve to shipped pages.

Mapping warnings

The skill's mapping.yaml is stale in five places. Full detail is in the findings file
(mapping_warnings:); summary:

Owner Stale entry Suggested fix
flashduty-docs derivative_surfaces.comparison_page points at `zh en/on-call/quickstart/comparison.mdx`
fc-event no module maps cmd/engine/controller/change, logic/change, model/change Add a change-integration mapping — these were 199 of fc-event's 218 changed files this window and are otherwise unreviewable by the diff
fc-datasource logic/data_source unmapped Map it to on-call/integration/{alert-integration,change-integration,instant-messaging}; today only model/* and structs/plugin.go are mapped, so Slack-side logic (slack_join.go, slack_scopes.go) is invisible
fc-pgy wallet/billing paths unmapped (logic/onprem, logic/api, cmd/server/controller/wallet, logic/permission, model/mis, model/bill) These are the changes most likely to invalidate `zh
flashduty-website content/changelog has no in-window entry Reported as a cross-repo follow-up rather than a docs edit

Skipped

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 in docs.json; change_status
including the new Failed value is documented in custom-event.mdx; the go-sdk / CLI generated
help diffs carry only that Failed enum and neither zh|en/developer/go-sdk.mdx nor cli.mdx
enumerates statuses; the monit-webapi close-task round-robin and backlog counters are internal
queue plumbing with no doc claim; fc-safari's deploy/sandbox, marketplace seed skills and
migrations are release tooling. Three out-of-window observations were deliberately not reported:
the harmony platform's remote-config support, Explore's missing 保存到仪表盘 entry, and the
可用额度 formula in platform/pricing.mdx — all predate 2026-09-29T08:04:41Z.

flashduty[bot] 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).

This branch has not been deployed

No deployments
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.

0 participants