Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed doc/_static/videos/editor/chat.webm
Binary file not shown.
Binary file added doc/_static/videos/editor/edit-app.webm
Binary file not shown.
Binary file removed doc/_static/videos/editor/edit-code.webm
Binary file not shown.
Binary file removed doc/_static/videos/editor/generate-code.webm
Binary file not shown.
Binary file added doc/static/ai-editor/revisions-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/static/ai-editor/secrets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 12 additions & 32 deletions doc/user-guide/ai-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,53 +8,33 @@ Try the AI editor [here.](https://editor.ploomber.io)
## Generating an app from a prompt

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

## Editing code

Select the code you want to edit, and press `CTRL + K` (or click on `Edit`), then type
the instructions and press `Enter`. The generated code will replace the selected code.

<video width="100%" controls autoplay loop muted>
<source src="../_static/videos/editor/edit-code.webm" type="video/webm">
Your browser does not support the video tag.
</video>


## Generating code

Place your cursor where you want to insert the code and press `CTRL + K`, then type
the instructions and press `Enter`.
## Editing apps

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


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


## Chat

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

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

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

## Save/Revisions
## Secrets

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

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

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

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

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