sleeping / retrying

Author: elithrar

src/content/docs/workflows/build/sleeping-and-retrying.mdx

@@ -18,14 +18,40 @@ A Workflow instance that is resuming from sleep will take priority over newly sc
 
 :::
 
-### Explicitly pausing a Workflow
-
-TODO
-
-### Resuming a Workflow
-
-TODO
 
 ## Retrying steps
 
-TODO
+Each call to `step.do` in a Workflow accepts an optional `StepConfig`, which allows you define the retry behaviour for that step.
+
+If you do not provide your own retry configuration, Workflows applies the following defaults:
+
+```ts
+const defaultConfig: WorkflowStepConfig = {
+	retries: {
+		limit: 5,
+		delay: 1000,
+		backoff: "constant",
+	},
+	timeout: "15 minutes",
+};
+```
+
+When providing your own `StepConfig`, you can configure:
+
+* The total number of attempts to make for a step
+* The delay between attempts
+* What backoff algorithm to apply between each attempt: any of `constant`, `linear`, or `exponential`
+* When to timeout (in duration) before considering the step as failed (including during a retry attempt).
+
+For example, to limit a step to 10 retries and have it apply an exponential delay (starting at 10 seconds) between each attempt, you would pass the following configuration as an optional object to `step.do`:
+
+```ts
+let someState = step.do("call an API", {
+  retries: {
+    limit: 10, // The total number of attempts
+    delay: "10 seconds", // Delay between each retry
+    backoff: "exponential" // Any of "constant" | "linear" | "exponential";
+  },
+  timeout: "30 minutes",
+}, async () => { /* Step code goes here /* }
+```

src/content/docs/workflows/build/trigger-workflows.mdx

@@ -81,6 +81,48 @@ export default {
 };
 ```
 
+### Explicitly pausing a Workflow
+
+You can explicitly pause a Workflow instance (and later resume it) by calling `pause` against a specific instance ID.
+
+```ts
+let instance = await env.MY_WORKFLOW.get("abc-123")
+await instance.pause() // Returns Promise<void>
+```
+
+### Resuming a Workflow
+
+You can resume a paused Workflow instance by calling `resume` against a specific instance ID.
+
+```ts
+let instance = await env.MY_WORKFLOW.get("abc-123")
+await instance.resume() // Returns Promise<void>
+```
+
+Calling `resume` on an instance that is not currently paused will have no effect.
+
+### Stopping a Workflow
+
+You can stop a Workflow instance by calling `abort` against a specific instance ID.
+
+```ts
+let instance = await env.MY_WORKFLOW.get("abc-123")
+await instance.abort() // Returns Promise<void>
+```
+
+Once stopped, the Workflow instance *cannot* be resumed.
+
+### Restarting a Workflow
+
+You can restart a Workflow instance by calling `restart` against a specific instance ID.
+
+```ts
+let instance = await env.MY_WORKFLOW.get("abc-123")
+await instance.restart() // Returns Promise<void>
+```
+
+Restarting an instance will immediately cancel any in-progress steps, erase any intermediate state, and treat the Workflow as if it was run for the first time.
+
 ## REST API (HTTP)
 
 TODO

src/content/docs/workflows/get-started/cli-quick-start.mdx

@@ -148,7 +148,7 @@ Specifically, the code above:
 4. Defines a custom retry configuration for a step.
 5. Binds to the Workflow from a Worker's `fetch` handler so that we can create (trigger) instances of our Workflow via a HTTP call.
 
-You can edit the Workflow by adding (or removing) additional `step` calls, changing the retry configuration, and/or making your own API calls. This Workflow template is designed to illustrate some of Workflows APIs.
+You can edit this Workflow by adding (or removing) additional `step` calls, changing the retry configuration, and/or making your own API calls. This Workflow template is designed to illustrate some of Workflows APIs.
 
 ## 2. Deploy a Workflow