Skip to content

Commit e9485b7

Browse files
laurakalbaglaurakalbag
authored
Document generate flow feature (#217)
* Document generate flow * Clarify text around open AI in generate flow * Add YouTube video
1 parent 7380db7 commit e9485b7

File tree

4 files changed

+132
-20
lines changed

4 files changed

+132
-20
lines changed

‎docs/generate-flow.mdx

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Generate flow
3+
---
4+
5+
**Generate flow** is an experimental feature that helps you auto-create machines from text descriptions. You can generate a flow for a new machine or use the flow description to describe how you want to modify your current flow.
6+
7+
:::studio
8+
9+
**Generate flow** is a Pro feature of the Studio. [Check out the features on our Pro plan](/studio-pro-plan.mdx) or [upgrade to try the Pro plan with a 30-day free trial](https://stately.ai/registry/billing).
10+
11+
:::
12+
13+
You have 1000 generations available to use each month. The number of available generations is reset at the beginning of each calendar month.
14+
15+
There are many reasons you might want to generate your flows, including:
16+
17+
- You have a complex machine in mind and want to get started quickly
18+
- You want an example of a state machine for a particular flow
19+
- You’re new and want to get an idea of how you can model state machines
20+
21+
<YouTube id="wjZE39wCZXo" />
22+
23+
## Generate a new flow
24+
25+
Generating a new flow will overwrite your current machine with an all-new flow created from your text description.
26+
27+
1. Use the **Generate flow** button to open the generate flow dialog.
28+
2. Deselect **Generate from current flow** to create an all-new flow. [Read more about generate from current flow below](#generate-from-current-flow).
29+
3. Enter a text description of the flow you want to generate in as much detail as possible.
30+
4. Use the **Generate** button to generate your flow.
31+
32+
When you generate an all-new flow, only your prompt text is sent to OpenAI.
33+
34+
## Generate from current flow
35+
36+
1. Use the **Generate flow** button to open the generate flow dialog.
37+
2. Ensure **Generate from current flow** is selected to modify your current machine.
38+
3. Enter a text description of the changes you want to make to your machine in as much detail as possible.
39+
4. Use the **Generate** button to generate your flow.
40+
41+
When you use **Generate from current flow**, we share your machine definition with OpenAI to help build the response.
42+
43+
## View history
44+
45+
You can view a history of text descriptions used to generate flows for the current machine. Use the **View history** button inside the **Generate flow** dialog to find your **Prompt history**.
46+
47+
- Use **Open flow** to preview the [version](versions.mdx) of the machine generated from the selected prompt.
48+
- Use **Copy to prompt** to copy the selected prompt into the text description area of the **Generate flow** dialog.
49+
50+
A new [version](versions.mdx) is auto-saved every time you generate a flow. Use the <History size={18} /> **Versions** panel and switch the **Show auto-saved versions** toggle on to browse auto-saved versions of your current machine.

‎sidebars.js

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -125,33 +125,39 @@ const sidebars = {
125125
collapsible: true,
126126
items: [
127127
{
128-
"type": "category",
129-
"label": "Design mode",
130-
"link": {
131-
"type": "doc",
132-
"id": "design-mode"
128+
type: 'category',
129+
label: 'Design mode',
130+
link: {
131+
type: 'doc',
132+
id: 'design-mode',
133133
},
134134
items: [
135+
{
136+
type: 'doc',
137+
label: 'Generate flow',
138+
id: 'generate-flow',
139+
className: 'pro-feature',
140+
},
135141
'import-from-code',
136142
'export-as-code',
137143
'machine-restore',
138144
'autolayout',
139145
'annotations',
140146
'descriptions',
141147
{
142-
"type": "doc",
143-
"label": "Colors",
144-
"id": "colors",
145-
"className": "pro-feature"
148+
type: 'doc',
149+
label: 'Colors',
150+
id: 'colors',
151+
className: 'pro-feature',
146152
},
147153
],
148154
},
149155
{
150-
"type": "category",
151-
"label": "Simulate mode",
152-
"link": {
153-
"type": "doc",
154-
"id": "simulate-mode"
156+
type: 'category',
157+
label: 'Simulate mode',
158+
link: {
159+
type: 'doc',
160+
id: 'simulate-mode',
155161
},
156162
items: [
157163
{
@@ -169,14 +175,14 @@ const sidebars = {
169175
className: 'pro-feature',
170176
},
171177
{
172-
"type": "doc",
173-
"label": "Lock machines",
174-
"id": "lock-machines",
175-
"className": "pro-feature"
178+
type: 'doc',
179+
label: 'Lock machines',
180+
id: 'lock-machines',
181+
className: 'pro-feature',
176182
},
177-
"keyboard-shortcuts",
183+
'keyboard-shortcuts',
178184
'canvas-view-controls',
179-
'user-preferences'
185+
'user-preferences',
180186
],
181187
},
182188
'projects',

‎versioned_docs/version-5/generate-flow.mdx

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Generate flow
3+
---
4+
5+
**Generate flow** is an experimental feature that helps you auto-create machines from text descriptions. You can generate a flow for a new machine or use the flow description to describe how you want to modify your current flow.
6+
7+
:::studio
8+
9+
**Generate flow** is a Pro feature of the Studio. [Check out the features on our Pro plan](/studio-pro-plan.mdx) or [upgrade to try the Pro plan with a 30-day free trial](https://stately.ai/registry/billing).
10+
11+
:::
12+
13+
You have 1000 generations available to use each month. The number of available generations is reset at the beginning of each calendar month.
14+
15+
There are many reasons you might want to generate your flows, including:
16+
17+
- You have a complex machine in mind and want to get started quickly
18+
- You want an example of a state machine for a particular flow
19+
- You’re new and want to get an idea of how you can model state machines
20+
21+
<YouTube id="wjZE39wCZXo" />
22+
23+
## Generate a new flow
24+
25+
Generating a new flow will overwrite your current machine with an all-new flow created from your text description.
26+
27+
1. Use the **Generate flow** button to open the generate flow dialog.
28+
2. Deselect **Generate from current flow** to create an all-new flow. [Read more about generate from current flow below](#generate-from-current-flow).
29+
3. Enter a text description of the flow you want to generate in as much detail as possible.
30+
4. Use the **Generate** button to generate your flow.
31+
32+
When you generate an all-new flow, only your prompt text is sent to OpenAI.
33+
34+
## Generate from current flow
35+
36+
1. Use the **Generate flow** button to open the generate flow dialog.
37+
2. Ensure **Generate from current flow** is selected to modify your current machine.
38+
3. Enter a text description of the changes you want to make to your machine in as much detail as possible.
39+
4. Use the **Generate** button to generate your flow.
40+
41+
When you use **Generate from current flow**, we share your machine definition with OpenAI to help build the response.
42+
43+
## View history
44+
45+
You can view a history of text descriptions used to generate flows for the current machine. Use the **View history** button inside the **Generate flow** dialog to find your **Prompt history**.
46+
47+
- Use **Open flow** to preview the [version](versions.mdx) of the machine generated from the selected prompt.
48+
- Use **Copy to prompt** to copy the selected prompt into the text description area of the **Generate flow** dialog.
49+
50+
A new [version](versions.mdx) is auto-saved every time you generate a flow. Use the <History size={18} /> **Versions** panel and switch the **Show auto-saved versions** toggle on to browse auto-saved versions of your current machine.

‎versioned_sidebars/version-5-sidebars.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@
9696
"items": [
9797
"import-from-code",
9898
"export-as-code",
99+
{
100+
"type": "doc",
101+
"label": "Generate flow",
102+
"id": "generate-flow",
103+
"className": "pro-feature"
104+
},
99105
{
100106
"type": "doc",
101107
"label": "Colors",

0 commit comments

Comments
 (0)