Skip to content

docs: doc-review findings for week of 2026-03-23#26

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

docs: doc-review findings for week of 2026-03-23#26
ysyneu merged 1 commit intomainfrom
doc-review/2026-03-23-120000

Conversation

@ysyneu
Copy link
Copy Markdown
Contributor

@ysyneu ysyneu commented Mar 23, 2026

Doc Review — 2026-03-23

Mode: diff (since 1 week ago)
Findings: 17 total — 5 high, 8 medium, 4 low

Changes

Finding Type Module Doc Action
f001 missing_coverage on-call create-edit.mdx Added External Reporting (外部提报) section
f002 missing_coverage on-call create-edit.mdx Added Managing Team (代管团队) section + contact note
f003 missing_coverage on-call/integration routing-rules.mdx Added Route Preview to operation tips
f004 missing_coverage on-call search-view-incident.mdx Updated tabs to show Postmortem, deprecated Resolution
f005 missing_coverage on-call what-is-incident.mdx Added external reporting as trigger method
f006 feature_drift on-call noise-reduction.mdx Updated aggregation window (now optional) + terminology
f007 feature_drift on-call create-edit.mdx Updated auto-resolve timeout with mode + time units
f008 stale_content on-call create-edit.mdx Updated settings to reflect Basic/Advanced split
f009 missing_coverage platform team-members.mdx Added verification status warning note
f010 feature_drift on-call (deferred — snooze presets) Minor, deferred to next review
f011 feature_drift on-call alert-management.mdx Updated alert status to 未恢复/已恢复
f012 feature_drift on-call alert-management.mdx Replaced 持续时间 column with 故障处理进度
f013 feature_drift on-call alert-webhook.mdx (deferred — needs API verification)
f014 config_drift on-call escalation-rule.mdx Added min 1 minute note
f015 config_drift platform configure-sso.mdx LDAP cert path now optional
f016 missing_coverage on-call alert-management.mdx (deferred — minor inline events)
f017 feature_drift on-call post-mortem docs (deferred — minor link)

Deferred findings

  • f010 (snooze presets from incident detail): Minor UX addition, deferred
  • f013 (data_source_* → integration_* rename): Needs API-side verification before updating webhook docs
  • f016 (inline related events): Minor UI enhancement
  • f017 (post_mortem_id on incidents): Minor cross-reference

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 screenshots still match (some may need updating)

Mapping warnings

  • Submodule src/Packages/saas was initially missed by parent repo git diff. Skill has been updated to handle submodules automatically.

🤖 Generated with Claude Code

Address documentation gaps and drift found by scanning code changes
from the past week across fc-event, fc-foundation-app (including saas
submodule), monit-webapi, and fc-statuspage.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@ysyneu ysyneu merged commit b135a53 into main Mar 23, 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