Skip to content

docs: correct on-call, integration, RUM, platform and AI SRE pages against current product behavior - #1157

Merged
ysyneu merged 6 commits into
mainfrom
doc-review/2026-10-31-full
Oct 31, 2026
Merged

ysyneu merged 6 commits into
mainfrom
doc-review/2026-10-31-full

Conversation

@ysyneu

@ysyneu ysyneu commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

Doc Review — 2026-10-31

Mode: full review of all modules against each repo's main
Findings: 116 total. 77 kept (3 high, 37 medium, 37 low), 39 dropped as additive detail the reader doesn't need. Of the 77, 76 are applied (10 of them in part) and 1 is deferred.

The goal was correctness, not more text: 636 lines added, 1,196 removed (416 of those are one orphaned page).

Changes

Area What changed
On-call Removed the incident related-links strip; link labels stay in the label list. Moved channel settings out of the create wizard into advanced settings. Corrected outlier and external reporting entry paths, alert list entry and filters, post-mortem panel and template fields, mobile app tabs, insights time presets, Zoom JID, Slack bot options, template fallback behavior. Stated the 31-day single-query span.
Integrations Image src and href limit is 512 characters, five images per event. Label mapping API request has no alert_id and images are objects. Routing rule copy runs from the current integration to others, with the console's three mode labels. files:read is no longer listed as requested by OAuth. DB Pull labels.
RUM Rule conditions are 匹配/不匹配 with exact match unless a wildcard or regex is used; the old 包含 examples would not match. Removed the STAGING upload option and its host. Added remoteConfigurationEnabled to the Web and WeChat mini program pages. Removed the Bitcode section and warnings that apply to no supported version.
Monitors Engine menu path, rule history entry and columns, clone entry.
Platform Removed the per-period license release limit, which no longer exists. Audit log retention follows the plan; a query can span 90 days. Added the AI SRE permission group and corrected Responder. SSO toggle label.
Status pages Create form, template flow, components and groups location, custom domain is public pages only, subscriber import entry.
AI SRE The reply mode claim is replaced by the real thread reply switch. Added /new, /stop, /help. DUTY.md has a 32 KB cap. Removed compaction internals.
Developer Removed release_limited and generator internals from the CLI page, a non-existent Go SDK symbol, and corrected the MCP time window.
Site-wide Fixed 36 alert source pages that failed to parse and blocked mint broken-links and mint validate. Removed the orphaned en/rum/quickstart/faq.mdx, with a redirect to /en/rum/sdk/web/faq.

Needs a decision

  • SLA figure: the on-call FAQ said 99.95% and compliance/service-sla says 99.9%. This PR changes the FAQ to 99.9%, because the SLA page is the contract. Please confirm 99.9% is current.
  • Android Gradle plugin: docs say cloud.flashcat.android-gradle-plugin 1.2.0, while the console snippet says cloud.flashcat.fc-sdk-android-gradle-plugin 1.0.0. Not changed: the plugin source isn't available to settle it.
  • Web SDK remote config version: the new text says 0.4.0 to match rum/quickstart/app-management, though the published package reads the option from 0.2.0.

Review checklist

  • mint broken-links and mint validate pass
  • api_path_redirects.py --check and lint_openapi.py pass
  • integration-docs build, check and tests pass (348 keys). The console bundle changed on 19 zh and 17 en pages: the Uptrends sentence, plus a paragraph break before the first-event note
  • zh and en updated together
  • Every edit re-checked hunk by hunk against code for lost facts, unsupported additions and label accuracy
  • Merges cleanly with all nine open docs PRs
  • Screens checked in a live console: not done, labels and flows come from frontend source

Cross-repo follow-ups

Deferred

Mapping warnings

None.

… pages

Separate console-only blocks from the preceding list with a blank line, drop
the unclosed wrapper on the StateCloud pages, and restore the broken Uptrends
prerequisite sentence.
…onsole

Remove the incident related-links strip, move channel settings out of the
create wizard, fix post-mortem and template descriptions, state the 31-day
query span, and align the FAQ availability figure with the service SLA.
…nd form labels

Image src and href allow 512 characters and an event keeps five images. The
label mapping API request has no alert_id and images are objects. Also fix
routing rule copy direction and the Slack OAuth scope list.
…emote config

Rule conditions use match and not match with exact values unless a wildcard or
regex is given. Remove the orphaned English quickstart FAQ with a redirect to
the Web SDK FAQ.
…ermissions

Remove the license release limit, which no longer exists. Fix status page
create, template and component descriptions, add the AI SRE permission group,
and correct the Monitors engine and rule history paths.
…LI and SDK details

Document /new, /stop and /help, the thread reply switch and the 32 KB DUTY.md
cap. Remove release_limited from the CLI reference and drop tool and generator
internals.
@ysyneu
ysyneu merged commit 65accf2 into main Oct 31, 2026
2 checks passed
@ysyneu
ysyneu deleted the doc-review/2026-10-31-full branch October 31, 2026 14:19
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