docs: sync doc-review findings (2026-08-06) - #245
Merged
Conversation
Covers product changes from the past five days across AI SRE, Monitors and RUM. - ai-sre/artifacts: document public (anonymous) artifact sharing — account-only vs public-link visibility, the content-snapshot model, update/revoke, and the 16 MiB cap; broaden publishable file types well beyond HTML/Markdown; correct the card type icon and title truncation - ai-sre/environments: add the degraded Runner status, its two detection signals and recovery paths, and note that degraded Runners stay selectable - ai-sre/knowledge: replace the extension allowlist with the content-based UTF-8 text rule; narrow the document-conversion list to the modern Office formats and call out legacy .doc/.xls/.ppt rejection - ai-sre/sessions: subagent/A2A child sessions are viewable read-only through a shared root link (no fork); forked dispatches always show as interrupted; HTML attachments - ai-sre/insight: entry kind scheduled -> automation, matching sessions.mdx - monitors/targets: new ServiceMap page (topology canvas, node/dependency detail fields, unresolved endpoints, host list, evidence quality) - monitors/quickstart: the data source type picker lists only configured types - rum/error-tracking: the Issue count on an application card deep-links into the error tracking list with the card's own scope
- changelog: new 2026-08-06 entry covering the artifact public-link sharing mode (snapshot semantics, update/revoke, 16 MiB cap), the broadened set of publishable artifact types, and the ServiceMap topology feature - monitors/targets/servicemap: mark the page as Beta and state the monit-agent eBPF dependency up front
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Review — 2026-08-06
Mode: diff (since 5 days ago)
Findings: 12 applied — 6 high, 3 medium, 3 low
Changes
All changes applied to both zh/ and en/ pages. The new ServiceMap page is registered in
docs.jsonfor both languages.Validation
mint broken-linkswas run after the edits. It reported no issues in any file touched by this PR. (The entries it did list are all/zh/api-reference/*paths that come from a separate, in-flight API-reference regeneration in the same checkout — none of them are introduced or referenced by this branch.)Review checklist
monitors/quickstart/quickstart.mdx基础配置 screenshot may be stale — the rule-group picker became a read-only breadcrumb, which the image still shows as a picker. Not changed here; needs a human to look at the image.Mapping warnings
None
Notes
rum/quickstart/app-management.mdx(which has no application-card section) torum/error-tracking/error-aggregation.mdx, where the Issue-list entry points are already described.Follow-up commit — changelog + ServiceMap Beta marker
Added after the initial review pass, at the product owner's request:
zh/changelog/changelog.mdx,en/changelog/changelog.mdx2026-08-06entry with two sections: artifact public links (snapshot semantics, update/revoke, 16 MiB cap, broadened publishable types) and ServiceMap (Beta)zh/monitors/targets/servicemap.mdx,en/monitors/targets/servicemap.mdxmonit-agenteBPF dependency up frontThe changelog entry links to
/{zh,en}/monitors/targets/servicemap, which this same PR creates — so the entry and its target page land together and the links are never broken.The matching website announcement is flashduty-website #43 (two entries, zh + en each). Its ServiceMap links point at the docs page added here, so this PR should merge first, or at the same time.