Correct the Status Events docs and add a status-correction tip - #980
Merged
Conversation
Deep-dive of the docs-pane Status Events section against its two sources of truth. Verified clean: the five event types match dispatch_event's enum as a set in both directions, done/waiting_user/blocked are exactly what triggers browser + Slack notifications, the activity monitor's 3-minute window and its "Activity detected" / "No recent activity detected" strings are exact, and every Activity-page claim (year heatmap, active hours, working-time stats, status breakdown) still renders. Two drifts fixed: - The sidebar claim only described top-level cards. #977 added describeAgentStatus, which sub agent rows and the Session details dialog use instead of the raw event label — a stopped or errored agent reads Stopped/Error there rather than a stale "Working", and one that hasn't reported yet reads "Running". None of those three labels were in the documented set. - "Startup rules tell the agent which event types to use" is only true on the verbose branch of buildLaunchGuidance. With Settings → Agents → Launch guidance → Use short startup rules on, that rule keeps the timing and the `blocked` distinction but deliberately leaves the type list to the dispatch_event tool description. Also adds an ambient tip for automatic status correction (since 0.21.9, confirmed by ancestry against the v0.21.8/v0.21.9 release commits): the Status Events section had no tip pointing at it, and a background loop authoring "No recent activity detected" under an agent's name is exactly the kind of thing a user reads as the agent's own report. Gave that H3 an id so the tip can deep-link to it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
Nightly docs audit. Slice: the docs-pane Status Events section (carried over from the last two runs, run this time regardless of the diff).
Verified clean
dispatch_event's enum as a set in both directions.done/waiting_user/blockedare exactly what triggers browser and Slack notifications (NOTIFY_EVENT_TYPES,web-notifications.ts).Fixed
Sidebar label set. The docs described only top-level cards. #977 added
describeAgentStatus, which sub agent rows and the Session details dialog use instead of the raw event label — a stopped or errored agent reads Stopped / Error there rather than a stale "Working", and one that hasn't reported yet reads Running. None of those three were in the documented set.Startup rules claim. "Tells the agent which event types to use" only holds on the verbose branch of
buildLaunchGuidance. With Settings → Agents → Launch guidance → Use short startup rules on, that rule keeps the timing and theblockeddistinction but deliberately leaves the type list to thedispatch_eventtool description.Added
An ambient tip for automatic status correction. The Status Events section had no tip pointing at it, and a background loop authoring "No recent activity detected" under an agent's name is exactly what a user reads as the agent's own report.
since: 0.21.9, confirmed withgit merge-base --is-ancestoragainst both the v0.21.8 and v0.21.9 release commits. Gave the H3 an id so the tip deep-links to it.Deferred
notification-settings-constants.tsdescribesblockedas "Agent hit an error or obstacle", andnotifications.tsxmirrors it — both contradict the injected guidance. The settings UI copy is the drifted artifact, so the docs were left mirroring it and the item went to the backlog for a product decision.agent-card-status.tsxshould adoptdescribeAgentStatustoo is a code question, backlogged.dispatch_eventmetadataparam stays undocumented — it is stored but never rendered anywhere user-visible. Backlog item closed.Next run: deep-dive the Notifications section.