more

Author: elithrar

src/content/docs/workflows/build/events-and-parameters.mdx

@@ -10,7 +10,7 @@ When a Workflow is triggered, it can receive an optional event. This event can i
 
 Events are a powerful part of a Workflow, as you often want a Workflow to act on data. Because a given Workflow instance executes durably, events are a useful way to provide a Workflow with data that should be immutable (not changing) and/or represents data the Workflow needs to operate on at that point in time.
 
-## Passing parameters
+## Passing parameters to a Workflow
 
 You can pass parameters to a Workflow in two ways:
 
@@ -55,7 +55,7 @@ npx wrangler@latest workflows trigger workflows-starter '{"some":"data"}'
 🚀 Workflow instance "57c7913b-8e1d-4a78-a0dd-dce5a0b7aa30" has been queued successfully
 ```
 
-## TypeScript and typing events
+## TypeScript and type parameters
 
 By default, the `WorkflowEvent` passed to the `run` method of your Workflow definition has a type that conforms to the following, with `payload` (your data) and `timestamp` properties:
 

src/content/docs/workflows/build/index.mdx

@@ -2,7 +2,7 @@
 title: Build with Workflows
 pcx_content_type: navigation
 sidebar:
-  order: 1
+  order: 2
 
 ---
 

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

@@ -23,11 +23,11 @@ You can build Workflows to post-process file uploads to [R2 object storage](/r2/
 
 ## Prerequisites
 
-:::note
+:::caution
 
 This guide is for users who are already familiar with Cloudflare Workers and [durable execution](/workflows/reference/how-workflows-works/) programming models.
 
-If you're new to either, we recommend the [introduction to Workflows](/workflows/get-started/guide/) guide, which steps through how a Workflow is defined, how to persist state, deploy and manage Workflows.
+If you're new to either, we recommend the [introduction to Workflows](/workflows/get-started/guide/) guide, which steps through how a Workflow is defined, how to persist state, and how to deploy and run your first Workflow.
 
 :::
 
@@ -44,7 +44,7 @@ Workflows are defined as part of a Worker script.
 To create a Workflow, use the `create cloudflare` (C3) CLI tool, specifying the Workflows starter template:
 
 ```sh
-npm create cloudflare@latest workflows-tutorial -- --template "cloudflare:workflows-tutorial"
+npm create cloudflare@latest workflows-starter -- --template "cloudflare:workflows-starter"
 ```
 
 This will create a new folder called `workflows-tutorial`, which contains two files:
@@ -56,20 +56,28 @@ Open the `src/index.ts` file in your text editor. This file contains the followi
 
 ```ts title="src/index.ts"
 // Import the Workflow definition
-import { Workflow, WorkflowEvent, WorkflowStep } from "cloudflare:workflows"
+import { WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from "cloudflare:workflows"
 
 // Create your own class that implements a Workflow
-export class MyFirstWorkflow implements Workflow {
+export class MyWorkflow implements WorkflowEntrypoint {
     // Define a run() method
     async run(event: WorkflowEvent, step: WorkflowStep) {
         // Define one or more steps that optionally return state.
-        let state = step.do("my first step", async () => {
-          
-        })
-
-        step.do("my second step", async () => {
-
-        })
+      	const state = await step.do('my first step', async () => {
+            return {}
+		});
+
+		await step.sleep('wait on something', '1 minute');
+
+		await step.do(
+			'make a call to write that could maybe, just might, fail',
+			async () => {
+				// Do stuff here, with access to 'state' from the previous step
+				if (Math.random() > 0.5) {
+					throw new Error('API call to $STORAGE_SYSTEM failed');
+				}
+			}
+		);
     }
 }
 ```
@@ -81,7 +89,7 @@ Specifically:
 3. TODO - how state is persisted
 4. TODO - retries and config
 5. TODO - triggering from a fetch handler
- 
+
 ```ts title="src/index.ts"