From 8b0ad79664fd818d514880e30338843f866ee9c6 Mon Sep 17 00:00:00 2001 From: Ty Dunn Date: Thu, 29 Jun 2023 22:55:07 -0700 Subject: how to use draft --- docs/docs/how-to-use-continue.md | 47 +++++++++++++++++++----------------- extension/react-app/src/tabs/gui.tsx | 2 +- 2 files changed, 26 insertions(+), 23 deletions(-) diff --git a/docs/docs/how-to-use-continue.md b/docs/docs/how-to-use-continue.md index 042983b1..e1efcac0 100644 --- a/docs/docs/how-to-use-continue.md +++ b/docs/docs/how-to-use-continue.md @@ -13,7 +13,7 @@ As you use Continue more, you will learn when to trust it. A great way to get st If you are trying to use it for a new task and don’t have a sense of how much Continue can help you complete it, it can often be helpful to start like this: 1. Highlight any code that you don’t understand and type `/explain tell me how this code works` -2. If the explanation seems reasonable, then, while still highlighting the code, type `/explain how would you change this code to do [INSERT TASK]?` +2. If the explanation seems reasonable, then, while still highlighting the code, type `/explain how would you change this code to [INSERT TASK]?` 3. If this explanation is also pretty good, then, while still highlighting the code, type `/edit [INSERT TASK]` 4. If it does not work on first attempt, click `reject` on its suggestions and try again—often it will make a different suggestion each time 5. If it not giving you what you want, click `reject` and try again with more specific / clear instructions, articulating exactly what you want it to do and not to do @@ -27,49 +27,43 @@ Here are tasks that Continue excels at helping you complete: ### Laborious edits -(e.g. situations where find and replace does not work) - -“Change all of these to be like that” but a find/replace doesn’t work +Continue works well in situations where find and replace does not work (i.e. “/edit change all of these to be like that”) ### Writing files from scratch - - React component - - Python script - - Shell script - - Unit tests +Continue can help you get started building React components, Python scripts, Shell scripts, Makefiles, Unit tests, etc. ### Creating projects from scratch -“Build the scaffolding for a python package that has a typer cli app to sort the arguments and print them back out” +Continue can go even further. For example, it can help build the scaffolding for a Python package, which includes a typer cli app to sort the arguments and print them back out. ### Fix highlighted code - - “change the function to work like this” - - “do this everywhere” - - refactoring functions +After selecting a code section, try to refactor it with Continue (e.g “/edit change the function to work like this”, “/edit do this everywhere”) ### Ask about highlighted code or an entire file +If you don't understand how some code works, highlight it and ask "/explain how does this code work?" ### Ask about errors -Have to copy-paste +Continue can also help explain errors and offer possible solutions. You will need to copy and paste the error text into the text input though. ### Figure out what shell command to run -How to I find running process on port 8000? - -### Ask open-ended questions like you would to ChatGPT without leaving your IDE. +Instead of switching windows and getting distracted, you can ask things like "/explain How to I find running process on port 8000?" -Mostly I’m doing this for ones where I don’t expect multi-turn. +### Ask single-turn open-ended questions -- get explanation of how to get Poetry’s bin directory in my `PATH` on a Windows 10 computer (after a powershell install) +Instead of leaving your IDE, you can ask open-ended questions that you don't expect to turn into multi-turn conversations. ### Editing small existing files +You can highlight an entire file and ask Continue to improve it as long as the file is not too large. ### Tasks with a few steps +There are many more tasks that Continue can help you complete. Typically, these will be tasks that don't involve too many steps to complete. ## When to not use Continue @@ -77,19 +71,28 @@ Here are tasks that Continue is **not** helpful with today: ### Deep debugging -If you are 20 minutes into debugging a complicated issue across many files, then Continue won’t be able to help you connect the dots yet. +If you are 20 minutes into debugging a complicated issue across many files, then Continue won’t be able to help you connect the dots yet. That said, Continue can provide ideas of what you might do at different points if you share what you have figured out along the way and ask for ideas of what to try. ### Multi-file edits in parallel At the moment, Continue can only edit one file at a time. If you figure out which files need to change, you can direct Continue to help with you change them one-by-one though. +### Using context of the entire file -### Tasks with many steps +If files get too large, it can be difficult for Continue to fit them into the limited LLM context windows. Try to highlight the section of code that include the relevant context. It's rare that you need the entire file. ### Editing large files +Similarly, if you try to edit too many lines at once, you might run into context window limits. It also will likely be very slow to apply the suggestions. + +### Highlighting really long lines + +If you highlight very long lines (e.g. a complex SVG), you might also run into issues like those above. + ### Using context from many other files -### Using context of the entire file +Similar to how you would make changes manually, focus on one file at a time. If there is key information in another file, try copy and pasting that section into the text input along with your `/edit` or `/explain` instructions. + +### Tasks with many steps -### Highlighting really long lines \ No newline at end of file +There are other tasks that Continue won't be able to take on as a whole. However, typically, if you figure out how to break the task into sub-tasks, you can get help from Continue with those. \ No newline at end of file diff --git a/extension/react-app/src/tabs/gui.tsx b/extension/react-app/src/tabs/gui.tsx index 292977c7..3e0fce6d 100644 --- a/extension/react-app/src/tabs/gui.tsx +++ b/extension/react-app/src/tabs/gui.tsx @@ -616,7 +616,7 @@ function GUI(props: GUIProps) { > - + -- cgit v1.2.3-70-g09d2 From a5a342a14073777439d09dc70c0079860333e042 Mon Sep 17 00:00:00 2001 From: Ty Dunn Date: Thu, 29 Jun 2023 23:14:13 -0700 Subject: initial walkthrough --- extension/media/edit.png | Bin 0 -> 246984 bytes extension/media/explain.png | Bin 0 -> 464952 bytes extension/media/generate.png | Bin 0 -> 1049613 bytes extension/package.json | 37 ++++++++++++++----------------------- 4 files changed, 14 insertions(+), 23 deletions(-) create mode 100644 extension/media/edit.png create mode 100644 extension/media/explain.png create mode 100644 extension/media/generate.png diff --git a/extension/media/edit.png b/extension/media/edit.png new file mode 100644 index 00000000..5e77c0ea Binary files /dev/null and b/extension/media/edit.png differ diff --git a/extension/media/explain.png b/extension/media/explain.png new file mode 100644 index 00000000..196ab914 Binary files /dev/null and b/extension/media/explain.png differ diff --git a/extension/media/generate.png b/extension/media/generate.png new file mode 100644 index 00000000..9d84e4ae Binary files /dev/null and b/extension/media/generate.png differ diff --git a/extension/package.json b/extension/package.json index 9d0ef3ac..b2db62e2 100644 --- a/extension/package.json +++ b/extension/package.json @@ -159,45 +159,36 @@ "walkthroughs": [ { "id": "continue", - "title": "Getting Started with Continue", - "description": "Learn how to effectively use Continue", + "title": "Getting Started", + "description": "Learn how to use Continue", "steps": [ { "id": "edit", - "title": "Highlight and Edit", - "description": "This step will run a command and check off once it has been run.\n[Run Command](command:getting-started-sample.runCommand)", + "title": "Edit in natural language", + "description": "Highlight a section of code and instruct Continue to refactor it (e.g. `/edit Make this use more descriptive variable names`)", "media": { - "image": "media/image.png", + "image": "media/edit.png", "altText": "Empty image" }, - "completionEvents": [ - "onCommand:continue.acceptSuggestion" - ] + "completionEvents": [] }, { "id": "explain", - "title": "Ask Questions", - "description": "This step will change a setting and check off when the setting has changed\n[Change Setting](command:getting-started-sample.changeSetting)", + "title": "Get possible explanations", + "description": "Ask Continue about a part of your code to get another perspective (e.g. `/explain how do I find running process on port 8000?`)", "media": { - "markdown": "media/walkthrough.md" + "image": "media/explain.png", + "altText": "Empty image" }, "completionEvents": [] }, { "id": "generate", - "title": "Generate Files from Scratch", - "description": "Ask Continue to create a file from scratch.", - "media": { - "markdown": "media/walkthrough.md" - }, - "completionEvents": [] - }, - { - "id": "commands", - "title": "Use a Slash Command", - "description": "Highlight some code then type '/explain' followed by a question. Slash commands let you select exactly the function you'd like Continue to perform. Others include '/edit' (to edit code), '/comment' (to comment code), and '/feedback' (to share with us what you think of Continue).", + "title": "Generate files from scratch", + "description": "Let Continue build the scaffolding of Python scripts, React components, and more (e.g. `Create a shell script to back up my home dir to /tmp/`)", "media": { - "markdown": "media/walkthrough.md" + "image": "media/generate.png", + "altText": "Empty image" }, "completionEvents": [] } -- cgit v1.2.3-70-g09d2