Skip to content

docs: doc-review 2026-09-07 — CLI/SSO/monitors/go-sdk/API 增量审计修复 - #358

Merged
ysyneu merged 1 commit into
mainfrom
doc-review/2026-09-07-084500
Sep 7, 2026
Merged

docs: doc-review 2026-09-07 — CLI/SSO/monitors/go-sdk/API 增量审计修复#358
ysyneu merged 1 commit into
mainfrom
doc-review/2026-09-07-084500

Conversation

@flashduty

@flashduty flashduty Bot commented Sep 7, 2026

Copy link
Copy Markdown

Doc Review — 2026-09-07

Mode: diff (since 2026-09-04T08:13:40Z, last successful run → now)
Findings: 26 total — 3 high, 19 medium, 4 low (plus 2 flashduty-website follow-ups below)
Window scan: 16 source repos + fc-foundation-app submodules (saas/rum/monit/ai-sre) + flashduty-website; monitors module source repos (monit-webapi/monit-edge) skipped — private.

Changes

Finding Type Module Doc Action
f001 missing_coverage cli developer/cli.mdx Added safari artifacts command family (11 cmds), public-share + sign/stream semantics
f002 missing_coverage cli developer/cli.mdx New monit datasource-tools-invoke section; monit-query diagnose marked legacy
f003 missing_coverage cli developer/cli.mdx --alerting-enabled / --enabled semantics + 5 new diagnostic type_idents + address/secret rules
f004 config_drift cli developer/cli.mdx monit-agent rewritten host-only (target-kind/locator, mysql.query example → os.overview)
f005 missing_coverage cli developer/cli.mdx insight incidents --fields + compact projection; new insight section
f006 feature_drift cli developer/cli.mdx 16 KiB output bound documented (rows dropped / '...' shortened / stderr notes)
f007 missing_coverage cli developer/cli.mdx status-page draft-create command + draft payload docs
f008 missing_coverage on-call/integration/sso NEW: role-team-sync.mdx New page: SAML2.0/OIDC/CAS claim-name role/team sync + defaults; docs.json (zh+en) registered; configure-sso.mdx cross-links
f009 missing_coverage on-call/integration/sso role-team-sync.mdx Matching semantics (exact case-sensitive, preset roles, smallest-ID, defaults-on-zero-match)
f010 config_drift monitors monitors/data-sources/data-sources.mdx 10→15 types + diagnostic-only notes + address formats (Redis/MongoDB/Kafka)
f011 missing_coverage monitors monitors/data-sources/data-sources.mdx New 启用与告警评估开关 section (enabled vs alerting_enabled, defaults, conflict)
f012 missing_coverage monitors monitors/targets/overview.mdx Datasource tools subsection (named tools per datasource, Edge ≥ v0.71.0, error codes, host-only boundary)
f013 missing_coverage on-call on-call/advanced/war-room.mdx War-room chats excluded from escalation/schedule group-chat pickers + 群聊不存在 fallback (also escalation-rule.mdx, schedule.mdx)
f014 config_drift rum rum/quickstart/app-management.mdx Adoption panel labels refreshed (采用情况/生效中/最近会话已切换/未收到配置/未上报)
f015 missing_coverage ai-sre ai-sre/sessions.mdx Task panel third entry point (click monitor/detached-bash tool row)
f016 missing_coverage statuspage on-call/analytics/insights.mdx Timezone row: dashboard times/bucketing follow viewer's effective timezone
f017 missing_coverage openapi openapi/api-catalog.mdx Added /monit/datasource/tools/invoke row; counts 39→40, 353→354 (zh+en)
f018 missing_coverage go-sdk developer/go-sdk.mdx client.Artifacts row + subsection; counts 337→349 (39 services)
f019 missing_coverage go-sdk developer/go-sdk.mdx DataSources.ToolsInvoke documented; QueryDiagnose marked deprecated with migration pointer
f020 missing_coverage go-sdk developer/go-sdk.mdx StatusPages.DraftCreate note (draft payload, change_id append, draft_id)
f021 missing_coverage go-sdk developer/go-sdk.mdx Expanded datasource contract (15 type_idents, payload fields, secrets, splits)
f022 missing_coverage go-sdk developer/go-sdk.mdx ErrorResponse/DutyError optional Reason field
d001 missing_coverage derivative zh/changelog/changelog.mdx New entry: SSO 同步配置 (SAML2.0/OIDC/CAS claim-name sync)
d002 missing_coverage derivative zh/changelog/changelog.mdx New entry: Monit 数据源诊断工具与新增数据源类型 (incl. alerting_enabled)
developer/overview.mdx, home.mdx, developer/cli.mdx Consistency count refreshes found in review: 337 → 349 (SDK ops), 354 (api-catalog total), 348/345 (OpenAPI ops / generated CLI commands) — all measured from source

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

Cross-repo follow-ups (flashduty-website)

  • d003 — Website changelog has no entry for the in-window SSO 角色/团队同步 feature (newest website changelog entry is 2026-08-11, status page widgets). Surface: SSO 同步配置 for SAML2.0/OIDC/CAS (claim-name role/team sync + defaults). Suggested: add a dated content/changelog/YYYY-MM-DD-*.mdx + .zh.mdx pair describing the feature.
  • d004 — Website changelog has no entry for Monit 数据源诊断 (datasource-tools-invoke, 5 new diagnostic datasource types, alerting_enabled split; shipped 2026-09-06, fc-safari PR #1075). Suggested: add a dated website changelog entry pair.

Mapping warnings

  • derivative_surfaces.comparison_page paths are stale: zh/on-call/quickstart/comparison.mdx does not exist; comparison pages now live at zh/on-call/comparison/vs-opsgenie.mdx / vs-pagerduty.mdx (+ statuspage/comparison.mdx). No comparison cells were invalidated by this window's features; update mapping.yaml.
  • monit-webapi / monit-edge are not available to this run (private); monitors module source diffs (backend) were not scanned — findings f010–f012 were derived from the fc-safari skill-card reference copies, which mirror the same API surface. Console-UI label verification for the new datasource switches was therefore not possible; docs use API/CLI field names.

Skipped

  • No findings were removed by the user (auto mode). Analyzer notes: on-call/integration + IM diffs were a pure type-cast cleanup (0 findings); the RUM miniprogram remote-config changes are already documented; the 09-04 changelog already covers the task panel and the 08-06/09-01 entries cover artifact public links and status-page draft, so no derivative entries were added for those.

… fixes

Findings (26): 3 high, 19 medium, 4 low — diff window 2026-09-04T08:13:40Z..2026-09-07.

- cli.mdx: safari artifacts command family, monit datasource-tools-invoke,
  datasource --alerting-enabled/--enabled, monit-agent host-only, insight --fields,
  16KiB output bound, status-page draft-create
- sso: new role-team-sync page (SAML2.0/OIDC/CAS claim-name sync) + docs.json + configure-sso links
- monitors: 10→15 datasource types, enabled/alerting_enabled split, datasource tools + Edge v0.71.0
- on-call: war-room chats excluded from group-chat pickers; analytics timezone row
- rum: adoption panel labels (采用情况)
- ai-sre: sessions task-panel third entry point
- api-catalog/go-sdk: tools-invoke row, client.Artifacts, DraftCreate, 5-type contract, Reason field,
  count refreshes (337→349/348/354)
- changelog: SSO sync + Monit datasource diagnostics entries
@ysyneu
ysyneu merged commit b4ae023 into main Sep 7, 2026
1 check passed
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