Skip to content

docs: sync doc-review findings (2026-07-29) - #228

Merged
ysyneu merged 2 commits into
mainfrom
doc-review/2026-07-29-194515
Jul 30, 2026
Merged

docs: sync doc-review findings (2026-07-29)#228
ysyneu merged 2 commits into
mainfrom
doc-review/2026-07-29-194515

Conversation

@ysyneu

@ysyneu ysyneu commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Doc Review — 2026-07-29

Mode: diff (since 1 day ago)
Findings: 21 total — 2 high, 8 medium, 11 low (19 applied, 2 dropped)

Changes

Finding Type Module Doc Action
f001 missing_coverage platform platform/configure-sso.mdx Added 稳定用户 ID 字段 (user_id) rows to all four protocol field tables (SAML/OIDC/CAS/LDAP) + new 成员关联方式 section (new configs link members by stable user ID, legacy configs keep email/phone)
f002 config_drift on-call/integration/sso on-call/integration/sso/authing.mdx Softened "email-only association" Notes; new SSO configs can link members via stable user ID field
f003 feature_drift rum rum/error-tracking/error-aggregation.mdx NDK exception note now covers Flutter native crashes resolved via source_type (NDK → frame fingerprint, iOS → message fingerprint)
f004 missing_coverage rum rum/error-tracking/source-mapping.mdx Added Flutter to platform lists and console tab list; new 上传 Flutter 符号文件 section (flashcat-cli flutter-symbols upload, iOS limitation), cross-linked Flutter SDK doc
f005 config_drift rum rum/analytics/native.mdx UV metric basis corrected to usr_anonymous_id (fallback usr_id) for Native/Flutter dashboards and app cards
f006 missing_coverage rum rum/quickstart/app-management.mdx App type list now includes HarmonyOS and Flutter; Flutter added to integration-guide list
f007 missing_coverage rum rum/analytics/native.mdx Documented Flutter platform differences (os_name filter, side-by-side ANR/App Hang cards, HarmonyOS limitations)
f008 missing_coverage rum rum/error-tracking/error-viewing.mdx Symbol file enumeration + Native stack section now cover Flutter symbols and Flutter native crash rendering
f010 missing_coverage monitors monitors/data-sources/data-sources.mdx Documented MySQL tls_mode / PostgreSQL ssl_mode selects, value meanings, CA constraints, monitedge version gates (v0.51.0 / v0.50.0)
f011 config_drift monitors monitors/data-sources/data-sources.mdx TLS client config table corrected: ServerName now optional (SNI), mTLS requires cert+key pair only, min/max TLS version options, labels aligned with zh UI
f012 stale_content monitors monitors/alert-rules/{mysql,clickhouse,postgres,oracle,sls}.mdx Removed 标签字段 config item; labels are now auto-derived from non-value fields
f013 stale_content monitors monitors/alert-rules/victorialogs.mdx Removed 标签字段 from raw-search config table and example
f014 config_drift monitors monitors/quickstart/quickstart.mdx 查询偏移 renamed to 查询时间偏移, moved to 检测频率与生效时间 step, scope noted (Prometheus/Loki/VictoriaLogs/SLS)
f015 config_drift monitors monitors/quickstart/quickstart.mdx Batch-edit field renamed to 查询时间偏移 + datasource restriction note
f016 missing_coverage ai-sre ai-sre/sessions.mdx New 分享会话 section (share entry, stable link, permissions, revoke semantics, incognito/subagent exclusions) — verified against frontend
f017 missing_coverage ai-sre ai-sre/skills.mdx Skill list toolbar: scope filter + keyword search documented (verified against frontend)
f018 missing_coverage ai-sre ai-sre/mcp.mdx MCP list search box documented (verified against frontend)
f019 missing_coverage ai-sre ai-sre/agents.mdx A2A agent list search box documented (verified against frontend)
f021 stale_content ai-sre ai-sre/agents.mdx OAuth discovery hint wording aligned: Safari 服务端 → AI SRE 服务端

All changes applied to both zh/ and en/ pages (38 files).

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

Mapping warnings

None (mapping paths were re-validated and fixed before this run).

Skipped

  • f009 (rumReplayFetchMode): private-deployment-only setting handled by support/delivery engineers — not end-user documentation; section removed after review.
  • f020 (Skill 英文描述 / description_en): API supports it, but the Skill edit form in the console does not expose the field yet — dropped per frontend-first rule.

- platform/sso: document stable user ID field and member association modes
- rum: Flutter symbolication (source-mapping, error-viewing, error-aggregation),
  Flutter app type & native dashboard differences, UV metric basis,
  private-deployment replay fetch mode
- monitors: MySQL/PostgreSQL TLS/SSL modes, TLS client config rework,
  remove label_fields (auto-derived), query time offset rename & relocation
- ai-sre: session sharing, list search/filters for skills/MCP/A2A agents,
  wording alignment (AI SRE server)
@ysyneu
ysyneu changed the base branch from feat/doc-review-auto-fix to main July 30, 2026 03:23
Deployment-level setting handled by support/delivery, not end-user facing.
@ysyneu
ysyneu merged commit 3957520 into main Jul 30, 2026
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