diff --git a/doc/_static/videos/editor/chat.webm b/doc/_static/videos/editor/chat.webm deleted file mode 100644 index 14d8a71c..00000000 Binary files a/doc/_static/videos/editor/chat.webm and /dev/null differ diff --git a/doc/_static/videos/editor/edit-app.webm b/doc/_static/videos/editor/edit-app.webm new file mode 100644 index 00000000..15d94834 Binary files /dev/null and b/doc/_static/videos/editor/edit-app.webm differ diff --git a/doc/_static/videos/editor/edit-code.webm b/doc/_static/videos/editor/edit-code.webm deleted file mode 100644 index 43ca7174..00000000 Binary files a/doc/_static/videos/editor/edit-code.webm and /dev/null differ diff --git a/doc/_static/videos/editor/generate-code.webm b/doc/_static/videos/editor/generate-code.webm deleted file mode 100644 index 60421382..00000000 Binary files a/doc/_static/videos/editor/generate-code.webm and /dev/null differ diff --git a/doc/static/ai-editor/revisions-view.png b/doc/static/ai-editor/revisions-view.png new file mode 100644 index 00000000..4d24fc14 Binary files /dev/null and b/doc/static/ai-editor/revisions-view.png differ diff --git a/doc/static/ai-editor/secrets.png b/doc/static/ai-editor/secrets.png new file mode 100644 index 00000000..8b129f99 Binary files /dev/null and b/doc/static/ai-editor/secrets.png differ diff --git a/doc/user-guide/ai-editor.md b/doc/user-guide/ai-editor.md index 41ad23b0..8c83057d 100644 --- a/doc/user-guide/ai-editor.md +++ b/doc/user-guide/ai-editor.md @@ -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. - - - - -## 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: -## 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 - +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`. \ No newline at end of file