Skip to content

Commit 3c00716

Browse files
authored
Update docs wording to match Deploy & Workflow renaming (#254)
1 parent 0ee3acd commit 3c00716

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/stately-sky-getting-started.mdx

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: 'Stately Sky getting started'
33
---
44

5-
# Getting started with Stately Sky
5+
# Getting started with Stately Sky 🌤️
66

7-
This guide will walk you through deploying a simple traffic light state machine actor with Stately Sky using [XState](/docs/xstate.mdx), [Vite](https://vitejs.dev/) and [React](https://reactjs.org/).
7+
This guide will walk you through deploying a simple traffic light state machine workflow with Stately Sky using [XState](/docs/xstate.mdx), [Vite](https://vitejs.dev/) and [React](https://reactjs.org/).
88

99
:::caution
1010

@@ -40,7 +40,7 @@ Sky only supports [XState](https://github.com/statelyai/xstate) V5 machines. The
4040

4141
After creating your machine, you’ll need to create an API key to deploy it to Sky.
4242

43-
1. Use the **Run** button in the top right corner of the editor to open the Stately Sky options.
43+
1. Use the **Deploy** button in the top right corner of the editor to open the Stately Sky options.
4444
2. Use the **Create API Key** button to generate an API key.
4545

4646
![No API key created yet](..//static/assets/sky-getting-started/editor-no-api-key.png)
@@ -53,13 +53,13 @@ The page should look like this:
5353

5454
## Step 3: Deploy your machine to Sky
5555

56-
Once you have generated the API key, you can deploy your machine to Sky as a running actor.
56+
Once you have generated the API key, you can deploy your machine to Sky as a workflow.
5757

58-
1. Use the **Deploy new actor** button to start the deployment process.
59-
2. When the actor is deployed, it will be listed under **Existing deploys**.
58+
1. Use the **Deploy to Sky 🌤️** button to start the deployment process.
59+
2. When the workflow is deployed, it will be listed under **Existing deploys**.
6060
3. Use **Copy URL** to copy to the URL to your clipboard.
6161

62-
You’ll need the running actor’s URL to communicate with that actor from the starter project.
62+
You’ll need the workflow’s URL to reference it from the starter project.
6363

6464
![Actor deployed](../static/assets/sky-getting-started/editor-deployed-actor.png)
6565

@@ -80,9 +80,9 @@ npm install
8080

8181
![.env file](../static/assets/sky-getting-started/code-env-file.png)
8282

83-
## Step 5: Initialize the actor in the starter project
83+
## Step 5: Add the actor in the starter project
8484

85-
After adding the API key, you’ll need to initialize the actor.
85+
After adding the API key, you’ll need to create an actor.
8686

8787
1. Create a new file in the `src` directory of the starter project. We named ours `trafficLightActor.ts`.
8888
2. In your new file, import the `actorFromStately` function and initialize the actor with the provided URL and your own session ID:
@@ -91,20 +91,23 @@ After adding the API key, you’ll need to initialize the actor.
9191
import { actorFromStately } from '@statelyai/sky';
9292

9393
const actor = actorFromStately({
94-
url: 'paste your actor url here',
94+
url: 'paste your Sky url here',
9595
sessionId: 'your session id here',
9696
});
9797
```
9898

99-
The session ID can be any string you want. We recommend using a UUID.
100-
10199
:::tip
102-
By default Sky is multiplayer. We use the session ID to allow multiple tenants to reference the same running actor instance.
100+
By default, Sky is multiplayer.
101+
The session ID is used to shard the multiplayer session. Each actor has a unique session ID.
102+
103+
- Use a shared session ID to allow multiple users to reference the same actor.
104+
- If you want users isolated, use a unique session ID for each user.
105+
103106
:::
104107

105-
## Step 6: Fetching the actor config from Sky
108+
## Step 6: Fetching the config from Sky
106109

107-
Now that we’ve initialized the actor, we need to fetch the config from Sky. Doing so will download and generate the machine configuration file in our repo, giving us type safety when interacting with the running actor!
110+
Now that we’ve created the actor, we need to fetch the config from Sky. Doing so will download and generate the machine configuration file in our repo, giving us type safety when interacting with the running actor!
108111

109112
To fetch the config, we’ll use the [XState CLI tool](/docs/developer-tools.mdx#xstate-cli-command-line-interface) and the `sky` script already in our `package.json`. This script runs the command over all the files in the `src` repo to find configs associated with any initialized actors.
110113

0 commit comments

Comments
 (0)