Skip to content

Commit 6005a49

Browse files
committed
edit ai-editor docs
1 parent 12efd87 commit 6005a49

File tree

7 files changed

+12
-32
lines changed

7 files changed

+12
-32
lines changed
-446 KB
Binary file not shown.
4.19 MB
Binary file not shown.
-285 KB
Binary file not shown.
-167 KB
Binary file not shown.
239 KB
Loading

doc/static/ai-editor/secrets.png

181 KB
Loading

doc/user-guide/ai-editor.md

Lines changed: 12 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -8,53 +8,33 @@ Try the AI editor [here.](https://editor.ploomber.io)
88
## Generating an app from a prompt
99

1010
In the [editor home page](https://editor.ploomber.io), type your app description and
11-
click on `Create app`. If you prefer to start from scratch, click on `Start from scratch`.
11+
click on `Create app`. If you prefer to start from scratch, click on `Blank no-code editor`.
1212

13-
## Editing code
14-
15-
Select the code you want to edit, and press `CTRL + K` (or click on `Edit`), then type
16-
the instructions and press `Enter`. The generated code will replace the selected code.
17-
18-
<video width="100%" controls autoplay loop muted>
19-
<source src="../_static/videos/editor/edit-code.webm" type="video/webm">
20-
Your browser does not support the video tag.
21-
</video>
22-
23-
24-
## Generating code
25-
26-
Place your cursor where you want to insert the code and press `CTRL + K`, then type
27-
the instructions and press `Enter`.
13+
## Editing apps
2814

15+
You can modify apps by sending relevant prompts after the initial prompt:
2916

3017

3118
<video width="100%" controls autoplay loop muted>
32-
<source src="../_static/videos/editor/generate-code.webm" type="video/webm">
19+
<source src="../_static/videos/editor/edit-app.webm" type="video/webm">
3320
Your browser does not support the video tag.
3421
</video>
3522

3623

37-
## Chat
3824

39-
Click on `Chat` or press `CTRL + L`, then type your question and press `Enter` (or
40-
click on `Send`). To hide the chat, click on `Chat` again or press `CTRL + L`
25+
## Revisions
4126

42-
<video width="100%" controls autoplay loop muted>
43-
<source src="../_static/videos/editor/chat.webm" type="video/webm">
44-
Your browser does not support the video tag.
45-
</video>
27+
Every message from the user creates a new revision of the app. You can select the required revision from the revisions history.
4628

29+
![AI Editor](../static/ai-editor/revisions-view.png)
4730

48-
## Save/Revisions
31+
## Secrets
4932

50-
To save your progress, click on `Save` or press `CTRL + S`. A new revision is created
51-
on each save and you can go back to old revisions by clicking on the history icon.
33+
You can add secrets needed by your app in the app settings:
5234

53-
## Sharing
35+
![AI Editor](../static/ai-editor/secrets.png)
5436

55-
To share your app, click on `Share` and you'll see multiple optiosn displayed.
37+
## Sharing
5638

57-
## Deployment
39+
To share your app, click on `Share`. You'll be able to generate a shareable link and also set an expiry for the same.
5840

59-
If you want to share your app as a WASM app, you can get the link by clicking the
60-
`Share` button. If you want to do a regular deploymenr, click on `Deploy`.

0 commit comments

Comments
 (0)