Skip to content

docs(doc-review): daily review 2026-10-30 — AI SRE config repair and resume, RUM native NL query, multi-value incident filters - #1156

Open
flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-30T080539Z
Open

flashduty[bot] wants to merge 1 commit into
mainfrom
doc-review/2026-10-30T080539Z

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 30, 2026

Copy link
Copy Markdown

Doc Review — 2026-10-30

Mode: diff (since 2026-10-29T08:17:22Z)
Findings: 7 total — 0 high, 5 medium, 2 low (5 applied in this PR, 1 derivative applied in this PR, 1 cross-repo follow-up)

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre `zh en/ai-sre/im.mdx`
f002 stale_content rum `zh en/rum/explorer/data-query.mdx`
f003 missing_coverage rum `zh en/rum/explorer/data-query.mdx`
f004 missing_coverage rum `zh en/rum/error-tracking/error-viewing.mdx`
f005 missing_coverage on-call `zh en/on-call/incident/search-view-incident.mdx`
f006 missing_coverage derivative `zh en/changelog/changelog.mdx`
f007 missing_coverage derivative flashduty-website (cross-repo) Not applied — see Cross-repo follow-ups

No path changes: no .mdx was renamed or moved, no docs.json navigation touched (jq empty docs.json passes), so no redirects are needed.

Overlap with open PRs

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
  • Reader-fit deletions removed only mechanism, never a limit, default, or behavior the reader relies on

Cross-repo follow-ups (flashduty-website)

Surface Feature Suggested action
content/changelog/ AI SRE: IM group's pinned team/environment repaired before the original question resumes; RUM natural-language queries now platform-aware for native apps Website changelog's newest entry is 2026-10-19 (110 files). Draft a dated .mdx + .zh.mdx pair for both features. Not applied here — docs repo only.

No derivative_surfaces.website_integrations follow-up: this window shipped no new or changed alert-source/tool integration, so the catalog and the "60+" counts are unaffected.

Mapping warnings

Repo Missing path Suggestion
fc-event cmd/engine/controller/notify/ add to on-call/integration (group/personal/@-mention delivery; this window's On-Call IM-app entitlement gate lives here)
fc-event logic/onboarding/ add to platform
fc-event cmd/server/controller/onboarding/ add to platform
fc-event structs/ai_sre.go add to ai-sre
fc-event logic/resource/usage.go add to platform (plan/usage resource logic)
fc-event structs/license.go add to platform
fc-rum cmd/server/controller/data/ add to rum (Explore query/sampling path)
fc-foundation-app src/Packages/saas/pages/StatusPage statuspage maps src/Packages/saas/pages/Dashboard; the console's Status Page pages live under pages/StatusPage
fc-foundation-app src/Packages/saas/pages/OnboardingOncall add to on-call
fc-foundation-app src/Packages/saas/pages/Onboarding removed on origin/main by b914aedeb "retire legacy quick-start onboarding pages" — drop from mapping
fc-foundation-app src/Packages/saas/pages/Guide removed on origin/main by 4d6a89327 "下线旧版 /init-channel 强制引导" — drop from mapping
flashduty-docs derivative_surfaces.comparison_page → `zh en/on-call/quickstart/comparison.mdx`

Skipped

  • monitors / absent_counts_as_normal (monit submodule RecoverRow.tsx, ruleFormValues.ts, types.ts; monit-webapi 0 commits) — covered by open docs(monitors): document counting absent alert objects as normal for threshold recovery #1147 (docs) and docs(api-reference): daily api-review 2026-10-29 — drop license release_limited, add rum cumulative, monit absent_counts_as_normal #1150 (OpenAPI); not re-filed.
  • IM app ⇒ On-Call Professional gate (fc-event structs/webhook.go IsIMApp(), notify/{fire,personal,mention}.go; saas Channel/imNotificationAccess.ts, 用于告警分派需 On-Call 专业版) — already documented as a version-requirement Tip on all five zh/on-call/integration/instant-messaging/*.mdx pages and in zh/ai-sre/{im,overview}.mdx, so no finding.
  • MCP per-user OAuth 401 handling (fc-safari logic/credential/service.go OnRejected, logic/tool/builtin/mcp.go) — no doc claim contradicts it; zh/ai-sre/mcp.mdx already says tokens refresh near expiry and only an expired credential needs re-authorising.
  • fc-statuspage IM notification entitlement (logic/notify.go CanSendIMNotify) — IM subscriptions only exist on internal status pages, which already require Professional (zh/on-call/statuspage/statuspage.mdx), so the gate cannot bite on a documented path; no finding.
  • AI SRE independent enablement/30-day billing (fc-safari logic/license/license.go, logic/credits/*, docs/ai-sre-billing.md; src/pages/Wallet/Subscription/AiSre) — already documented in zh/ai-sre/overview.mdx §开通与计费.
  • Non-user-facing diffs reviewed and discarded: fc-oncall callee/pgy.go (billing RPC), fc-datasource/fc-pgy/terraform-provider/flashduty-cli/mcp-server/flashduty-runner/go-flashduty/flashduty-app/monit-webapi/monit-edge (0 mapped commits), fc-event PG/Mongo parity internals, monit onboarding datasource cards losing their one-line descriptions (pure layout).

Validation

  • mint broken-links (Node v20.18.0, mint 4.2.1178): success no broken links found in the files that parsed. Exit code 1 is the 36 pre-existing parse failures, all under on-call/integration/alert-integration/alert-sources/*.mdx.
  • Skipped-list check: the 36 skipped files ∩ this branch's 10 changed files = empty (comm -12), i.e. every changed file was really parsed and link-checked, not skipped.
  • jq empty docs.json → OK (navigation untouched, no new pages).

…resume, RUM native NL query, multi-value incident filters

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