diff options
author | Ty Dunn <ty@tydunn.com> | 2023-09-04 16:09:41 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-09-04 16:09:41 -0700 |
commit | 5894a559a6235d61ef8d3e1c5c54822923e1656a (patch) | |
tree | 84f93a461035f3481f804389d6ce622091033fa2 /docs | |
parent | 702086eb6a1b50c9c698fbe7ed74dd7b2f499953 (diff) | |
download | sncontinue-5894a559a6235d61ef8d3e1c5c54822923e1656a.tar.gz sncontinue-5894a559a6235d61ef8d3e1c5c54822923e1656a.tar.bz2 sncontinue-5894a559a6235d61ef8d3e1c5c54822923e1656a.zip |
intro, getting started, how to (#452)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docs/getting-started.md | 6 | ||||
-rw-r--r-- | docs/docs/how-to-use-continue.md | 44 | ||||
-rw-r--r-- | docs/docs/intro.md | 4 | ||||
-rw-r--r-- | docs/static/img/continue-screenshot.png | bin | 325885 -> 200263 bytes |
4 files changed, 24 insertions, 30 deletions
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index 36555d9a..18d99f08 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -4,8 +4,6 @@ 2. This will open the Continue extension page in VS Code, where you will need to click `Install` again
-3. Once you do this, you will see a message in the bottom right hand corner of VS Code that says `Setting up Continue extension...`. After 30-90 seconds, the Continue extension will then open up:
+3. Once you do this, you will see the Continue logo show up on the left side bar. If you click it, then the Continue extension will then open up:
-![vscode-install](/img/continue-screenshot.png)
-
-4. Enjoy!
+![vscode-install](/img/continue-screenshot.png)
\ No newline at end of file diff --git a/docs/docs/how-to-use-continue.md b/docs/docs/how-to-use-continue.md index 8089d131..1fd8e99c 100644 --- a/docs/docs/how-to-use-continue.md +++ b/docs/docs/how-to-use-continue.md @@ -12,20 +12,26 @@ 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 `tell me how this code works` in the text box of the Continue side bar -2. If the explanation seems reasonable, then, while still highlighting the code, type `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]` +1. Highlight the code section(s) that you don’t understand and type "tell me how this code works" in the intput box +2. If the explanation seems reasonable, then, while still highlighting the code section(s), type "how would you change this code to [INSERT TASK]?" +3. If this explanation is also pretty good, then, while still highlighting the code section(s), 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 +5. If it is not giving you what you want after another attempt, click `reject` and try again with more specific / clear instructions, articulating exactly what you want it to do and not to do 6. If this still does not work, then you likely need to break down the task into smaller sub-tasks and ask the LLM to do each of those one at a time or just do it yourself manually Remember: You are responsible for all code that you ship, whether it was written by you or by an LLM that you directed. This means it is crucial that you review what the LLM writes. To make this easier, we provide natural language descriptions of the actions the LLM took in the Continue GUI. +## Keyboard shortcuts + +Here you will find a list of all of the default keyboard shortcuts in VS Code: + +![keyboard-shortucts](/img/keyboard-shortcuts.png) + ## When to use Continue Here are tasks that Continue excels at helping you complete: -### Laborious edits +### Laborious edits Continue works well in situations where find and replace does not work (i.e. “/edit change all of these to be like that”) @@ -35,13 +41,13 @@ Examples ### Writing files from scratch -Continue can help you get started building React components, Python scripts, Shell scripts, Makefiles, Unit tests, etc. +Continue can help you get started building React components, Python scripts, Shell scripts, Makefiles, unit tests, etc. Examples -- “/edit write a python script to get Posthog events" -- “/edit add a React component for syntax highlighted code" +- “/edit write a python script to get posthog events" +- “/edit add a react component for syntax highlighted code" -### Creating projects from scratch +### Creating boilerplate from scratch 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. @@ -51,7 +57,7 @@ Examples ### Fix highlighted code -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”) +After selecting the code section(s), try to refactor it with Continue (e.g “/edit change the function to work like this” or “/edit do this everywhere”) Examples - “/edit migrate this digital ocean terraform file into one that works for GCP” @@ -67,11 +73,7 @@ Examples ### Ask about errors -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. - -Examples -- “explain this error to me in human understandable way” -- "what are some ideas for how I might solve this problem?" +Continue can also help explain errors / exceptions and offer possible solutions. When you come across an error / exception in your terminal, press `cmd+shift+r` (MacOS) / `ctrl+shift+r` (Windows). This will throw the stack trace into Continue and ask for it to explain the issue to you. ### Figure out what shell command to run @@ -99,7 +101,7 @@ Examples ### Using context from multiple other files -Similar to how you would make changes manually, focus on one file at a time. But if there is key information in other files, highlight those sections of code too +Similar to how you would make changes manually, focus on one file at a time. But if there is key information in other files, highlight those sections of code too to be used as additional context ### Tasks with a few steps @@ -119,7 +121,7 @@ If you are 20 minutes into debugging a complicated issue across many files, then ### 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. +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 you change them one at a time though. ### Using context of the entire file @@ -135,10 +137,4 @@ If you highlight very long lines (e.g. a complex SVG), you might also run into i ### Tasks with many steps -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. - -## Keyboard shortcuts - -Here you will find a list of all of the default keyboard shortcuts in VS Code: - -![keyboard-shortucts](/img/keyboard-shortcuts.png) +There are other tasks that Continue won't be able to take on entirely at once. 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/docs/docs/intro.md b/docs/docs/intro.md index 731a42ab..dcd50151 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -4,6 +4,6 @@ **Continue is the open-source autopilot for software development—a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Continue.continue) that brings the power of ChatGPT to your IDE** -You determine when Large Language Models (LLMs) like [GPT-4](https://openai.com/research/gpt-4) should act as an autopilot, helping you complete software development tasks. You highlight some code and then use natural language instructions (and optional slash commands like `/edit`) to tell the language model what to do. +You determine when Large Language Models (LLMs) like [GPT-4](https://openai.com/research/gpt-4) and [Code Llama](https://about.fb.com/news/2023/08/code-llama-ai-for-coding/) should act as an autopilot, helping you complete software development tasks. You highlight some code and then use natural language instructions (and optional slash commands like `/edit`) to tell the LLM what to do. -Many developers have begun to use [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much copying, pasting, and editing is required to provide the context and incorporate the generated answers into your codebase. Continue eliminates this pain by enabling LLMs to natively act in your IDE as you complete your workflows.
\ No newline at end of file +Many developers have begun to use ChatGPT while coding; however, the experience is painful because of how much copying, pasting, and editing is required to provide the context and incorporate the generated answers into your codebase. Continue eliminates this pain by enabling LLMs to natively act in your IDE as you complete your workflows.
\ No newline at end of file diff --git a/docs/static/img/continue-screenshot.png b/docs/static/img/continue-screenshot.png Binary files differindex 3ace8602..ab5af919 100644 --- a/docs/static/img/continue-screenshot.png +++ b/docs/static/img/continue-screenshot.png |