Correct the Automations docs against the jobs and templates code (docs audit) - #963
Merged
Merged
Conversation
Deep-dive of the docs-pane Automations section (in-app docs), plus the same claims in docs/17-jobs.md and the jobs/templates skills. Wrong claims fixed: - Jobs were said to add "notifications". JobNotifier is wired up, but its channel lists come from job.notify, which nothing writes — it is absent from createJob's INSERT, JobConfigUpdate, the route schemas, and the MCP tools. Per-job Slack has never fired. What does notify is the ordinary per-agent path, which job agents are not excluded from. - The run timeout was described as covering started/running only. The monitor checks it against the run start time for every active status, so the 30 min default kills a run parked on job_needs_input long before the 24 h wait-for-input timeout. - needs_input was said to end when "someone resumes it". There is no answer box in the Jobs pane; the human replies in the agent's terminal. - Template launches were described as filling arguments inline (detail pane) and as an Enter-twice confirm (palette). All three paths open the same launch dialog. - Template agentType lists omitted cursor/terminal; field tables omitted model, allowMedia, and selfImprove. - 17-jobs.md described an answer box and an MCP log stream that do not exist, and a two-tab sidebar that now has three. Filled in by omission: when a run is recorded as crashed, the Configure tab's immediate-write Enabled switch and Remove job, the Jobs overview's 7-day stats and Recent Activity, the last-five-job_log-lines-per-task limit in History, the hidden backing template, and the webhook endpoint. Also drops a duplicated review-tools bullet and adds an ambient tip for job webhook triggers, which nothing surfaced before. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Nightly docs audit. Deep-dive of the docs-pane Automations section — the
next_focuscarried over from #960, and the first time this section has been audited against the code.Audited
docs-sections/automations.tsxagainstautomations-form-fields.tsx,jobs-add-dialog.tsx,jobs-settings-tab.tsx,jobs-detail-pane.tsx,jobs-history-tab.tsx,jobs-overview.tsx,jobs/service.ts,jobs/store.ts,templates/service.ts,notifications/job-notifier.ts, andJOB_TOOLSinshared/mcp/server.ts. Cross-checkeddocs/17-jobs.md,skills/jobs/SKILL.md,skills/templates/SKILL.md.Clean as a set in both directions: the template create/edit field list, the job create dialog + Advanced list, the 53-entry job agent tool list, the seven run statuses, the three trigger-source labels, and the self-improve guidance text.
Wrong claims fixed
JobNotifieris wired into the run-state callback, but its channel lists come fromjob.notify— a column nothing writes (absent fromcreateJob's INSERT, fromJobConfigUpdate, from the route Zod schemas, and from MCPcreate_job/update_job). Per-job Slack has never fired. What does notify is the ordinary per-agent path, which job agents are not excluded from.running. The monitor checksnow - startedAt >= timeoutMsfor every active status, so the 30 min default kills a run parked onjob_needs_input~23.5 h before the 24 h wait-for-input timeout it advertises.needs_inputrun from the UI — there is no answer box; the human replies in the agent's terminal.agentTypelists omittedcursor/terminal; field tables omittedmodel,allowMedia,selfImprove.docs/17-jobs.mddescribed an answer box and an MCP log stream that do not exist, and a two-tab Automations sidebar that now has three.Filled in by omission
When a run is recorded
crashed; the Configure tab's immediate-write Enabled switch and Remove job; the Jobs overview's 7-day stats, charts, and Recent Activity; the last-five-job_log-lines-per-task limit in History; the hidden backing template; the webhook endpoint and its rate limit. Also drops a review-tools bullet that duplicated the one above it.Tip
Adds an ambient
job-webhookstip — the webhook trigger is buried in a job's Configure tab and nothing surfaced it.since: 0.22.0, confirmed bygit merge-base --is-ancestor aca12314 <release>.Deferred to next run
next_focusis the Media & Sharing section (tab set vsMediaSidebarTab, pin types vsdispatch_pin/dispatch_pins, upload paths, retention claims). Backlog gained two product decisions this audit surfaced but did not fix: jobnotifyhas no write path at all, and jobcallableis fully inert while two UI surfaces and the MCP tool description still promise palette/API behavior.