Skip to content

docs: fix documentation drift (1-month diff review)#27

Merged
ysyneu merged 1 commit intomainfrom
doc-review/2026-03-23-153833
Mar 23, 2026
Merged

docs: fix documentation drift (1-month diff review)#27
ysyneu merged 1 commit intomainfrom
doc-review/2026-03-23-153833

Conversation

@ysyneu
Copy link
Copy Markdown
Contributor

@ysyneu ysyneu commented Mar 23, 2026

Doc Review — 2026-03-23

Mode: diff (since 1 month ago)
Findings: 21 total — 6 high, 11 medium, 4 low
Applied: 20 findings (f020 already documented)

Changes

Finding Type Module Doc Action
f001 feature_drift statuspage publish-events.mdx Added tip about pre-start-time timeline updates for scheduled maintenances
f002 feature_drift statuspage publish-events.mdx Added note about first timeline entry auto-adjusting start_time
f003 feature_drift platform team-members.mdx Added team detail page documentation (add/remove members, leave team)
f004 feature_drift platform permission-design.mdx Added inline role editing documentation
f005 feature_drift platform permission-design.mdx Updated batch grant/revoke workflow description
f006 feature_drift platform permission-design.mdx Updated permission grouping to scope-based (Platform/On-call/RUM/Monitors)
f007 feature_drift platform configure-sso.mdx Removed stale '登录域名' from per-protocol field tables
f008 feature_drift monitors data-sources.mdx, quickstart.mdx Added dual data source binding mode (wildcard + exact match by ID)
f009 missing_coverage monitors data-sources.mdx Added VictoriaLogs as 9th data source type
f010 missing_coverage monitors quickstart.mdx Added quick-edit-by-rule-ID tip
f011 missing_coverage on-call/integration servicedesk-plus-sync.mdx Added Call History tab documentation
f012 missing_coverage on-call/integration nagios.mdx (NEW) Created Nagios alert integration page (zh + en)
f013 feature_drift on-call/integration custom-actions.mdx Fixed TLS verification toggle wording
f014 missing_coverage on-call/integration label-enhancement.mdx Updated mapping mode to inline radio toggle
f015 feature_drift on-call search-view-incident.mdx Expanded postmortem tab description
f016 feature_drift on-call handle-update-incident.mdx Updated snooze presets configuration details
f017 stale_content on-call create-edit.mdx Updated channel navigation from tabs to sidebar menu
f018 missing_coverage rum source-mapping.mdx Added Android ProGuard/R8 and iOS dSYM upload workflows
f019 missing_coverage rum app-management.mdx Added in-console SDK setup guide reference
f020 feature_drift rum native.mdx Already documented — no changes needed
f021 missing_coverage rum error-viewing.mdx Added native error detail view with thread-based stack traces

Not applied (missing from knowledge-base)

  • Emqx, Rizhiyi, Datadog alert integration pages — docs not yet written in knowledge-base repo

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
  • Verify new Nagios page renders correctly

Mapping warnings

None

🤖 Generated with Claude Code

Address 20 findings across 6 modules identified by doc-review diff analysis:

- statuspage: Timeline behavior for scheduled maintenances (f001-f002)
- platform: Team detail page, role editing, batch grant/revoke, permission scope grouping, SSO field removal (f003-f007)
- monitors: Dual data source binding, VictoriaLogs type, quick-edit shortcut (f008-f010)
- on-call/integration: ServiceDesk Plus call history, Nagios integration page, TLS toggle wording, label mapping UI (f011-f014)
- on-call: Embedded postmortem tab, snooze presets config, channel navigation restructure (f015-f017)
- rum: Android/iOS source mapping upload, SDK setup guides, native error detail view (f018-f021)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ysyneu ysyneu merged commit 592a4dd into main Mar 23, 2026
1 check passed
@ysyneu ysyneu deleted the doc-review/2026-03-23-153833 branch March 23, 2026 08:20
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