Skip to content

Commit de04cea

Browse files
authored
Finish renaming "embedded" world to "local" in docs (#269)
Signed-off-by: Nathan Rajlich <n@n8.io>
1 parent 4f9ae4e commit de04cea

File tree

7 files changed

+11
-10
lines changed

7 files changed

+11
-10
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This repository contains the client side SDK code for workflows, along example a
1616
- **packages/next**: Next.js integration (`@workflow/next`)
1717
- **packages/cli**: Command-line interface (`@workflow/cli`)
1818
- **packages/world**: Core interfaces and types for workflow storage backends (`@workflow/world`)
19-
- **packages/world-embedded**: Filesystem-based workflow backend for local development and testing (`@workflow/world-local`)
19+
- **packages/world-local**: Filesystem-based workflow backend for local development and testing (`@workflow/world-local`)
2020
- **packages/world-vercel**: Production workflow backend for Vercel platform deployments (`@workflow/world-vercel`)
2121
- **packages/swc-plugin-workflow**: SWC compiler plugin for workflow transformations
2222
- **workbench/example**: Basic workflow examples using the CLI (aka "standalone mode")

docs/content/docs/deploying/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ A **World** connects workflows to the infrastructure that powers them. Think of
1919

2020
Worlds are automatically configured depending on the scenario:
2121

22-
- **Local development** - Automatically uses the Embedded World
22+
- **Local development** - Automatically uses the Local World
2323
- **Vercel deployments** - Automatically uses the Vercel World
2424

2525
When using other worlds, you can explicitly set configuration through environment variables. Reference the documentation for the appropriate world for configuration details.
@@ -29,7 +29,7 @@ When using other worlds, you can explicitly set configuration through environmen
2929
Workflow DevKit ships with two world implementations:
3030

3131
<Cards>
32-
<Card title="Embedded World" href="/docs/deploying/world/embedded-world">
32+
<Card title="Local World" href="/docs/deploying/world/local-world">
3333
Filesystem-based backend for local development, storing data in `.workflow-data/` directory.
3434
</Card>
3535
<Card title="Vercel World" href="/docs/deploying/world/vercel-world">
@@ -75,7 +75,7 @@ Learn more about [Observability](/docs/observability) tools.
7575

7676
## Learn More
7777

78-
- [Embedded World](/docs/deploying/world/embedded-world) - Local development backend
78+
- [Local World](/docs/deploying/world/local-world) - Local development backend
7979
- [Vercel World](/docs/deploying/world/vercel-world) - Production backend for Vercel
8080
- [World API Reference](/docs/deploying/world) - Building custom worlds
8181
- [Observability](/docs/observability) - Inspecting workflow data

docs/content/docs/deploying/world/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The workflow `World` is an interface that abstracts how workflows and steps comm
1616

1717
## Choosing a World implementation
1818

19-
* By default, Workflow uses the [Local world](/docs/deploying/world/embedded-world) for easy local development.
19+
* By default, Workflow uses the [Local world](/docs/deploying/world/local-world) for easy local development.
2020
* When deployed on Vercel, Workflow switches to the [Vercel world](/docs/deploying/world/vercel-world).
2121

2222
If you want to use a different World implementation, set the `WORKFLOW_TARGET_WORLD` environment variable to your desired World package's NPM name:
@@ -30,7 +30,7 @@ export MY_WORLD_CONFIG=... # implementation-specific configuration
3030

3131
Workflow DevKit provides two built-in world implementations:
3232

33-
- [Embedded World](/docs/deploying/world/embedded-world) - Filesystem-based for local development
33+
- [Local World](/docs/deploying/world/local-world) - Filesystem-based for local development
3434
- [Vercel World](/docs/deploying/world/vercel-world) - Production-ready for Vercel deployments
3535

3636
## Community Worlds

docs/content/docs/deploying/world/embedded-world.mdx renamed to docs/content/docs/deploying/world/local-world.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,4 @@ const world = createEmbeddedWorld('./my-data', 3000);
199199
- [World Interface](/docs/deploying/world) - Understanding the World interface
200200
- [Vercel World](/docs/deploying/world/vercel-world) - For production deployments
201201
- [Observability](/docs/observability) - Monitoring and debugging tools
202+
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"title": "World",
3-
"pages": ["world", "embedded-world", "vercel-world", "postgres-world"]
3+
"pages": ["world", "local-world", "vercel-world", "postgres-world"]
44
}

docs/content/docs/deploying/world/vercel-world.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,12 +221,12 @@ If workflows don't work after deployment:
221221
1. Verify `withWorkflow()` is wrapping your Next.js config
222222
2. Check build logs for errors
223223
3. Ensure workflow files are in the correct directory
224-
4. Test locally first with [Embedded World](/docs/deploying/world/embedded-world)
224+
4. Test locally first with [Local World](/docs/deploying/world/local-world)
225225

226226
## Learn More
227227

228228
- [World Interface](/docs/deploying/world) - Understanding the World interface
229-
- [Embedded World](/docs/deploying/world/embedded-world) - For local development
229+
- [Local World](/docs/deploying/world/local-world) - For local development
230230
- [Observability](/docs/observability) - Monitoring and debugging tools
231231
- [Vercel Deployment Documentation](https://vercel.com/docs/deployments/overview)
232232
- [Workflow Documentation on Vercel](https://vercel.com/docs/workflow)

packages/core/src/runtime.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,7 @@ export const stepEntrypoint =
673673
workflowRunId,
674674
workflowStartedAt: new Date(+workflowStartedAt),
675675
// TODO: there should be a getUrl method on the world interface itself. This
676-
// solution only works for vercel + embedded worlds.
676+
// solution only works for vercel + local worlds.
677677
url: process.env.VERCEL_URL
678678
? `https://${process.env.VERCEL_URL}`
679679
: `http://localhost:${port ?? 3000}`,

0 commit comments

Comments
 (0)