diff options
author | Ty Dunn <ty@tydunn.com> | 2023-06-03 10:07:36 +0200 |
---|---|---|
committer | Ty Dunn <ty@tydunn.com> | 2023-06-03 10:07:36 +0200 |
commit | 32d99938439b6f8fd9d008f6dc1acee1e3935783 (patch) | |
tree | 582236bf41c173c1c529a5817d45ca64562e1d4f /docs | |
parent | 411060e2557f34c8dc7e378da6fbf859486fbd0a (diff) | |
download | sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.tar.gz sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.tar.bz2 sncontinue-32d99938439b6f8fd9d008f6dc1acee1e3935783.zip |
README updates
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docs/getting-started.md | 2 | ||||
-rw-r--r-- | docs/docs/install.md | 14 | ||||
-rw-r--r-- | docs/docs/intro.md | 10 | ||||
-rw-r--r-- | docs/docs/walkthroughs/create-a-recipe.md | 2 |
4 files changed, 15 insertions, 13 deletions
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index c2c359ad..feca0832 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -22,6 +22,6 @@ If you would like to use Continue locally, you can follow [these steps](./instal If you'd like to continue exploring in GitHub Codespaces, you can learn more with our walkthroughs:
- [Use the GUI](./walkthroughs/use-the-gui.md)
-- [Invoke a recipe](./walkthroughs/use-a-recipe.md)
+- [Use a recipe](./walkthroughs/use-a-recipe.md)
- [Create a recipe](./walkthroughs/create-a-recipe.md)
- [Share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index 7e36ffd5..a19b2e8c 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -1,22 +1,22 @@ # Installation
:::note
-If you want to try `Continue` before installing, check out the [GitHub Codespaces Demo](./getting-started.md)
+If you want to try Continue before installing locally, check out the [GitHub Codespaces Demo](./getting-started.md)
:::
-## Install `Continue` locally in VS Code
+## Install Continue locally in VS Code
-1. Click `Install` on the `Continue` extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
+1. Click `Install` on the Continue extension in the Visual Studio Marketplace [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
-2. This will open the `Continue` extension page in VS Code, where you will need to click `Install` again
+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 a couple minutes, the Continue extension will then open up. It should look like this when it is complete:
-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 a couple minutes, the `Continue` extension will then open up
-**TODO: Finish writing out this step-by-step**
## How to install from source
-Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install `Continue` from source.
+Please follow the [README instructions in the repo](https://github.com/continuedev/continue/blob/main/README.md) to install Continue from source.
## Next steps
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 489d91f6..084f9450 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -4,17 +4,17 @@ ## Quickstart -1. Try out `Continue` in the [GitHub Codespaces Demo](./getting-started.md) -2. Install `Continue` packaged as a [VS Code extension](./install.md) +1. Try out Continue in the [GitHub Codespaces Demo](./getting-started.md) +2. Install Continue packaged as a [VS Code extension](./install.md) ## What is `Continue`? -**`Continue` is the open-source library for accelerating software development with language models** +**Continue is the open-source library for accelerating software development with language models** You define the scenarios where Large Language Models ([LLMs](./concepts/llm.md)) like GPT-4 and StarCoder should act as an autopilot, helping you complete software development tasks. You use [recipes](./concepts/recipe.md) created by others to automate more steps in your workflows. If a [recipe](./concepts/recipe.md) does not exist or work exactly like you want, you can use the [Continue SDK](./concepts/sdk.md) to create custom [steps](./concepts/step.md) and compose them into personalized [recipes](./concepts/recipe.md). Whether you are using a [recipe](./concepts/recipe.md) created by yourself or someone else, you can review, reverse, and rerun [steps](./concepts/step.md) with the [Continue GUI](./concepts/gui.md), which helps you guide the work done by LLMs and learn when to use and trust them. ## Why do developers use `Continue`? -Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and incorporate the generated solutions into your codebase. `Continue` eliminates this pain by deeply integrating LLMs into your IDE amd workflows. +Many developers have begun to use models like [GPT-4](https://openai.com/research/gpt-4) through [ChatGPT](https://openai.com/blog/chatgpt) while coding; however, the experience is painful because of how much manual copying, pasting, and editing is required to supply them with context and incorporate the generated solutions into your codebase. Continue eliminates this pain by deeply integrating LLMs into your IDE amd workflows. -`Continue` accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
\ No newline at end of file +Continue accelerates how developers build, ship, and maintain software, while giving them the control to define when LLMs should take actions and the confidence to trust LLMs. In short, it enables developers to do what they have always done: work together to create better and better abstractions that make it easier and easier to automate the repetitive work that people want computers to do.
\ No newline at end of file diff --git a/docs/docs/walkthroughs/create-a-recipe.md b/docs/docs/walkthroughs/create-a-recipe.md index 12dd3167..6a32906a 100644 --- a/docs/docs/walkthroughs/create-a-recipe.md +++ b/docs/docs/walkthroughs/create-a-recipe.md @@ -1,5 +1,7 @@ # Create a recipe
+Check out the [recipes folder](https://github.com/continuedev/continue/tree/main/continuedev/src/continuedev/recipes) to learn how to write your own.
+
**TODO: Describe step-by-step how to create a recipe**
Points to include
|