Merge branch 'main' of github.com:vercel/workflow into update/serialize-step-function-reference

Author: TooTallNate

.changeset/lucky-dolphins-flow.md

@@ -0,0 +1,5 @@
+---
+"@workflow/builders": patch
+---
+
+Add .svelte-kit to ignored paths

.changeset/pink-aliens-itch.md

@@ -0,0 +1,5 @@
+---
+"workflow": patch
+---
+
+Update readme

CLAUDE.md

@@ -160,5 +160,5 @@ This project uses pnpm with workspace configuration. The required version is spe
   - All changed packages should be included in the changeset. Never include unchanged packages.
   - All changes should be marked as "patch". Never use "major" or "minor" modes.
 - Remember to always build any packages that get changed before running downstream tests like e2e tests in the workbench
-- Remember that changes made to one workbench should propogate to all other workbenches. The workflows should typically only be written once inside the example workbench and symlinked into all the other workbenches
-- When writing changeset, use the `pnpm changeset` command from the root of the repo. Keep the changesets terse (see existing changesets for examples). Try to amke chagnesets that are specific to each modified package so they are targeted. Ensure that any breaking changes are marked as "**BREAKING CHANGE**
+- Remember that changes made to one workbench should propagate to all other workbenches. The workflows should typically only be written once inside the example workbench and symlinked into all the other workbenches
+- When writing changesets, use the `pnpm changeset` command from the root of the repo. Keep the changesets terse (see existing changesets for examples). Try to make changesets that are specific to each modified package so they are targeted. Ensure that any breaking changes are marked as "**BREAKING CHANGE**"

docs/content/docs/foundations/errors-and-retries.mdx

@@ -65,7 +65,7 @@ async function callApi(endpoint: string) {
 
 ## Customize Retry Behavior
 
-When you need to customize the delay on the retry, use [`RetryableError`](/docs/api-reference/workflow/retryable-error)and set the retryAfter property.
+When you need to customize the delay on the retry, use [`RetryableError`](/docs/api-reference/workflow/retryable-error) and set the retryAfter property.
 
 ```typescript lineNumbers
 import { FatalError, RetryableError } from "workflow";
@@ -95,7 +95,7 @@ async function callApi(endpoint: string) {
 
 ## Advanced Example
 
-This final example combines everything we've learnt, along with [`getStepMetadata`](/docs/api-reference/workflow/get-step-metadata).
+This final example combines everything we've learned, along with [`getStepMetadata`](/docs/api-reference/workflow/get-step-metadata).
 
 ```typescript lineNumbers
 import { FatalError, RetryableError, getStepMetadata } from "workflow";
@@ -129,7 +129,7 @@ async function callApi(endpoint: string) {
 callApi.maxRetries = 5;
 ```
 
-## Rolling back failed steps
+## Rolling Back Failed Steps
 
 When a workflow fails partway through, it can leave the system in an inconsistent state.
 A common pattern to address this is "rollbacks": for each successful step, record a corresponding rollback action that can undo it.

docs/content/docs/foundations/index.mdx

@@ -4,8 +4,8 @@ title: Foundations
 
 # Foundations
 
-Workflow programming can be a slight shift from how you traditionally write real world applications. Learning the foundations
-now will go a long way in using workflows.
+Workflow programming can be a slight shift from how you traditionally write real-world applications. Learning the foundations
+now will go a long way in helping you use workflows effectively.
 
 <Cards>
     <Card href="/docs/foundations/workflows-and-steps" title="Workflows and Steps">

docs/content/docs/foundations/workflows-and-steps.mdx

@@ -43,10 +43,10 @@ export async function processOrderWorkflow(orderId: string) {
 - All step results are persisted to the event log
 - Must be **deterministic** to allow resuming after failures
 
-Determinism in the workflow is required in order to resume to workflow from a suspension. Essentially, the workflow code gets re-run multiple times during its lifecycle,
-each time, using an event log to resume the workflow to the correct spot.
+Determinism in the workflow is required in order to resume the workflow from a suspension. Essentially, the workflow code gets re-run multiple times during its lifecycle,
+each time using an event log to resume the workflow to the correct spot.
 
-The sandboxed environment that workflows are run in already ensures determinism. For instance, `Math.random` and `Date` constructors are fixed in workflow runs, so you are safe to use them and the framework ensures that the values don't change across replays.
+The sandboxed environment that workflows run in already ensures determinism. For instance, `Math.random` and `Date` constructors are fixed in workflow runs, so you are safe to use them and the framework ensures that the values don't change across replays.
 
 ## Step Functions
 

packages/builders/src/base-builder.ts

@@ -107,6 +107,7 @@ export abstract class BaseBuilder {
         '**/.vercel/**',
         '**/.workflow-data/**',
         '**/.well-known/workflow/**',
+        '**/.svelte-kit/**',
       ],
       absolute: true,
     });

packages/workflow/README.md

@@ -32,7 +32,7 @@ Contributions to Workflow DevKit are welcome and highly appreciated. Please use
 
 Workflow DevKit was built by engineers at [Vercel](https://vercel.com) and the [Open Source Community](https://github.com/vercel/workflow/graphs/contributors).
 
-The initial core contributing engineers are
+The initial core contributing engineers are:
 
 - Adrian Lam ([@adriandlam](https://github.com/adriandlam))
 - Dillon Mulroy ([@dmmulroy](https://github.com/dmmulroy))