Skip to content

docs(automations): read as one guide, from a five-minute walkthrough to the reference - #619

Merged
adeelahmad merged 2 commits into
mainfrom
claude/project-thread-li6m25
Oct 18, 2026
Merged

adeelahmad merged 2 commits into
mainfrom
claude/project-thread-li6m25

Conversation

@adeelahmad

Copy link
Copy Markdown
Owner

Requested by Adeel · project thread

Description

Before: docs/automations.md grew one module at a time. It opened on a 50-row status table, some parts were still labelled "until approvals and timers are built" or "(M6)", and nothing walked a newcomer from nothing to a working automation.

After: it reads as one guide.

  • It opens with what automations are and an "In this guide" list.
  • "Five minutes: tell me when the school emails" goes from the starter to its run on the timeline.
  • The reference follows: the studio, contract, approvals, time, variables, saving and running.
  • New "Limits and costs" and "The API and MCP tools" tables come next.
  • The status table moved to the end, and Refine later collects every open item.

Also in this PR:

  • Stale labels are fixed.
  • A lens_help test checks that the assistant answers "how do I get told when the school emails" from this guide.
  • The new clicks journey automation-starter is in both baselines: 4 clicks on a computer, and 5 taps and a swipe on a phone.
  • A changelog fragment covers the studio's release line.

Motivation and Context

Workflow studio M12, the last module. Build steps 1 (one guide with a lens_help check), 5 (the clicks count recorded) and 6 (release lines) land here. Steps 2 to 4 merged in #612, #606 and #616. Step 7, the Done-questions table for the whole studio, is below.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change; ! in the title)

Checklist:

  • The title is a Conventional Commit.
  • My code follows the code style of this project (make hooks checks it on commit).
  • I added or updated tests: test_lens_help.py::test_the_automations_guide_answers_how_to_be_told_when_the_school_emails, and the automation-starter baselines.
  • My change requires documentation updates: docs/automations.md, docs/requirements.md.
  • CHANGELOG: changelog.d/workflow-studio.md.

Checks run:

  • mkdocs build --strict is clean.
  • ci/check_requirements.py passes.
  • test_lens_help.py: 7 passed.
  • Local CI pre-commit job passes, and pre-commit passes on the changed files.

Done questions for the workflow studio (AGENTS.md)

# Question Answer for the studio (M1 to M12)
1 Goal Yes, once this merges. Make an automation in words, from a starter or in When, If and Then. Test it, save it and turn it on. It runs from the stream and the clock, and asks first when it should. The journey test from an email to a yes covers it (#606).
2 Agents Yes. Every studio action has an API route, and most have MCP and assistant tools ("The API and MCP tools" table). Drafting, starters, delete and restore, and deciding a held run are API-only for now (Refine later).
3 Zero setup Yes. Nothing new to install, and automations work after the install line.
4 Fewest clicks Yes. A starter takes 4 clicks to save and turn on, with no typing. On a phone it takes 5 taps and a swipe (Refine later).
5 Configurable Yes. Settings → Automations covers whether they run, their limits, how long runs are kept and timer lateness, with defaults. None of it is in the setup wizard.
6 Light Yes. Followers poll the stream, and nothing heavy runs. Model calls happen only in actions that ask for them, and in drafting from a sentence.
7 Private and secure Yes. Every automations entry in the threat model names its mitigation and test (#612). Webhooks store only a hash, outbound calls are SSRF-guarded, outside text is wrapped, and agents can't approve.
8 Cost Yes. Model calls go through the activity ledger and budgets, a run over budget is held, and each automation's page shows its costs.
9 User decides Yes. Anything with risk asks first, starters and agent-saved automations are off, and turning on or running from an agent is an approval.
10 Upgrades Yes. The studio's tables came with their upgrade steps in earlier modules. This PR changes no stored data.
11 Honest Yes. The guide labels each part built, in progress or planned, and only merged parts are called built. lens_help answers cite this guide.
12 Tested and documented Yes. Backend, web and journey tests, clicks baselines, one guide and requirements rows.
13 Open Yes. Activities follow W3C Activity Streams 2.0 shapes, and no new dependencies are added.
14 Reported Yes, in the project thread. Refine-later items are collected in Refine later.
15 Reuse Yes. It builds on the canvas, SchemaForm, timers, channels, the activity ledger and the clicks harness.

Generated by Claude Code

…puter and 5 taps and a swipe on a phone

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AjJqXgjj1cNdKGRQbX5frb
@adeelahmad adeelahmad self-assigned this Oct 18, 2026
@adeelahmad
adeelahmad merged commit 899dd1a into main Oct 18, 2026
11 checks passed
@adeelahmad
adeelahmad deleted the claude/project-thread-li6m25 branch October 18, 2026 14:44
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.

2 participants