diff options
Diffstat (limited to 'docs/docs')
| -rw-r--r-- | docs/docs/concepts/agent.md | 10 | ||||
| -rw-r--r-- | docs/docs/concepts/autopilot.md | 11 | ||||
| -rw-r--r-- | docs/docs/concepts/core.md | 2 | ||||
| -rw-r--r-- | docs/docs/concepts/history.md | 2 | ||||
| -rw-r--r-- | docs/docs/concepts/ide.md | 4 | ||||
| -rw-r--r-- | docs/docs/concepts/llm.md | 2 | ||||
| -rw-r--r-- | docs/docs/concepts/policy.md | 2 | ||||
| -rw-r--r-- | docs/docs/concepts/recipe.md | 2 | ||||
| -rw-r--r-- | docs/docs/concepts/sdk.md | 4 | ||||
| -rw-r--r-- | docs/docs/concepts/state.md | 9 | ||||
| -rw-r--r-- | docs/docs/concepts/step.md | 2 | ||||
| -rw-r--r-- | docs/docs/getting-started.md | 16 | ||||
| -rw-r--r-- | docs/docs/how-continue-works.md | 12 | ||||
| -rw-r--r-- | docs/docs/install.md | 18 | ||||
| -rw-r--r-- | docs/docs/intro.md | 21 | ||||
| -rw-r--r-- | docs/docs/sdk.md | 1 | ||||
| -rw-r--r-- | docs/docs/telemetry.md | 18 | ||||
| -rw-r--r-- | docs/docs/walkthroughs/create-a-recipe.md | 8 | ||||
| -rw-r--r-- | docs/docs/walkthroughs/share-a-recipe.md | 4 | ||||
| -rw-r--r-- | docs/docs/walkthroughs/use-a-recipe.md | 4 | ||||
| -rw-r--r-- | docs/docs/walkthroughs/use-the-gui.md | 4 |
21 files changed, 112 insertions, 44 deletions
diff --git a/docs/docs/concepts/agent.md b/docs/docs/concepts/agent.md deleted file mode 100644 index e2fa6832..00000000 --- a/docs/docs/concepts/agent.md +++ /dev/null @@ -1,10 +0,0 @@ -# Autopilot
-
-`Autopilot` contains the
-
-- History
-- LLM
-- Policy
-- IDE
-
-**Q: should we really call this abstraction autopilot?**
diff --git a/docs/docs/concepts/autopilot.md b/docs/docs/concepts/autopilot.md new file mode 100644 index 00000000..5fc2a220 --- /dev/null +++ b/docs/docs/concepts/autopilot.md @@ -0,0 +1,11 @@ +# Autopilot
+
+*TODO: Explain in detail what this is and what its purpose is*
+
+`Autopilot` contains the
+- History
+- LLM
+- Policy
+- IDE
+
+**We should rename agent to autopilot in the code**
\ No newline at end of file diff --git a/docs/docs/concepts/core.md b/docs/docs/concepts/core.md index d60f46ac..445379fb 100644 --- a/docs/docs/concepts/core.md +++ b/docs/docs/concepts/core.md @@ -1,5 +1,7 @@ # Core
+*TODO: Explain in detail what this is and what its purpose is*
+
The `Core` connects the SDK and GUI with the IDE (i.e. in VS Code, a web browser, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
The `Core` includes
diff --git a/docs/docs/concepts/history.md b/docs/docs/concepts/history.md index e6c2a5ea..5c52e158 100644 --- a/docs/docs/concepts/history.md +++ b/docs/docs/concepts/history.md @@ -1,5 +1,7 @@ # History
+*TODO: Explain in detail what this is and what its purpose is*
+
`History` is the ordered record of all past steps.
**Q: What step data and metadata is stored in the history?**
\ No newline at end of file diff --git a/docs/docs/concepts/ide.md b/docs/docs/concepts/ide.md index 980b589d..4f30995f 100644 --- a/docs/docs/concepts/ide.md +++ b/docs/docs/concepts/ide.md @@ -1,11 +1,15 @@ # IDE
+*TODO: Explain in detail what this is and what its purpose is*
+
## Supported IDEs
### VS Code
The VS Code extension implementation can be found at `/continue/extension/src`
+### GitHub Codespaces
+
## IDE Protocol methods
### handle_json
diff --git a/docs/docs/concepts/llm.md b/docs/docs/concepts/llm.md index 8c2dbcba..293bdae2 100644 --- a/docs/docs/concepts/llm.md +++ b/docs/docs/concepts/llm.md @@ -1,5 +1,7 @@ # LLM
+*TODO: Explain in detail what this is and what its purpose is*
+
`LLM` is the large language model that can be used in steps to automate that require some judgement based on context (e.g. generating code based on docs, explaining an error given a stack trace, etc)
**Q: should we call this LLM? Perhaps just model?**
diff --git a/docs/docs/concepts/policy.md b/docs/docs/concepts/policy.md index 6fbbc8d7..58de2606 100644 --- a/docs/docs/concepts/policy.md +++ b/docs/docs/concepts/policy.md @@ -1,5 +1,7 @@ # Policy
+*TODO: Explain in detail what this is and what its purpose is*
+
The policy determines what step to run next
**Q: what else do folks need to understand about policies?**
diff --git a/docs/docs/concepts/recipe.md b/docs/docs/concepts/recipe.md index bc171b1d..3f051a4d 100644 --- a/docs/docs/concepts/recipe.md +++ b/docs/docs/concepts/recipe.md @@ -1,5 +1,7 @@ # Recipe
+*TODO: Explain in detail what this is and what its purpose is*
+
An ordered sequence of steps that are intended to accomplish some complete task
Actually just a step that is composed of only other steps / recipes.
diff --git a/docs/docs/concepts/sdk.md b/docs/docs/concepts/sdk.md index e5ca2f99..3316d2d0 100644 --- a/docs/docs/concepts/sdk.md +++ b/docs/docs/concepts/sdk.md @@ -1,5 +1,9 @@ # SDK
+*TODO: Explain in detail what this is and what its purpose is*
+
+*TODO: Detail all the SDK methods and how to use them*
+
The `SDK` gives you access to tools (e.g. open a directory, edit a file, call an LLM, etc), which you can use when defining how a step should work and composing them with other steps.
## SDK methods
diff --git a/docs/docs/concepts/state.md b/docs/docs/concepts/state.md deleted file mode 100644 index d48dbe88..00000000 --- a/docs/docs/concepts/state.md +++ /dev/null @@ -1,9 +0,0 @@ -# State
-
-*Note: this is only a proposed concept at this point*
-
-Steps can add, edit, and remove observations / memories stored in state.
-
-Allows you to pass context of previous steps, other files, etc.
-
-Alternative names: memory, observation store
\ No newline at end of file diff --git a/docs/docs/concepts/step.md b/docs/docs/concepts/step.md index d381f06e..1f33a955 100644 --- a/docs/docs/concepts/step.md +++ b/docs/docs/concepts/step.md @@ -1,5 +1,7 @@ # Step
+*TODO: Explain in detail what this is and what its purpose is*
+
A step is
## Step methods
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index 8b3a7945..0324f89e 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -1 +1,15 @@ -# Getting Started
\ No newline at end of file +# Getting started
+
+## GitHub Codespaces Demo
+
+*TODO: Describe step-by-step how to try the GitHub Codespaces Demo*
+
+## Next Steps
+
+If you would prefer to use Continue locally, we reccommend installing `Continue` packaged as a VS Code extension as described [here](./install.md).
+
+Otherwise, if you would like to continue to use GitHub Codespaces, then you should now go through the walkthroughs:
+- How to [use the GUI](./walkthroughs/use-the-gui.md)
+- How to [use a recipe](./walkthroughs/use-a-recipe.md)
+- How to [create a recipe](./walkthroughs/create-a-recipe.md)
+- How to [share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file diff --git a/docs/docs/how-continue-works.md b/docs/docs/how-continue-works.md index e29faef8..a41986d0 100644 --- a/docs/docs/how-continue-works.md +++ b/docs/docs/how-continue-works.md @@ -1,9 +1,11 @@ -# How Continue works
+# How `Continue` works
-The Continue library consists of a `SDK`, a `GUI`, and a `Core` that brings everything together.
+*TODO: Describe in more detail how `Continue` works*
-The `SDK` gives you access to tools (e.g. open a directory, edit a file, call a model, etc), which you can use when defining how a step should work and composing them with other steps.
+The `Continue` library consists of a [SDK](./concepts/sdk.md), a [GUI](./concepts/gui.md), and a [Core](./concepts/core.md) that brings everything together.
-The `GUI` enables you to guide steps and makes everything transparent, so you can review all steps that were automated, giving you the opportunity to undo and rerun any that ran incorrectly.
+The [SDK](./concepts/sdk.md) gives you access to tools (e.g. open a directory, edit a file, call a model, etc), which you can use when defining how a step should work and composing them with other steps.
-The `Core` connects the SDK and GUI with the IDE (i.e. in VS Code, a web browser, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
\ No newline at end of file +The [GUI](./concepts/gui.md) enables you to guide steps and makes everything transparent, so you can review all steps that were automated, giving you the opportunity to undo and rerun any that ran incorrectly.
+
+The [Core](./concepts/core.md) connects the SDK and GUI with the IDE (i.e. in VS Code, a web browser, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index f34d65bd..923e7bd1 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -1 +1,17 @@ -# Installation
\ No newline at end of file +# Installation
+
+If you want to try out `Continue` without having to install it, check out the [GitHub Codespaces Demo](./getting-started.md)
+
+## Install `Continue` packaged as a VS Code extension
+
+Steps for installing `Continue` packaged as a VS Code extension...
+
+*TODO: Describe step-by-step how to install `Continue` packaged as a VS Code extension*
+
+## Next steps
+
+Now that you have installed the VS Code extension, you should go through the walkthroughs:
+- How to [use the GUI](./walkthroughs/use-the-gui.md)
+- How to [use a recipe](./walkthroughs/use-a-recipe.md)
+- How to [create a recipe](./walkthroughs/create-a-recipe.md)
+- How to [share a recipe](./walkthroughs/share-a-recipe.md)
\ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 286fbd2d..2d92d777 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -1,21 +1,20 @@ # Introduction -## Scripts reimagined in the age of LLMs + -### Automate more steps of your software development workflows using LLMs +## What is `Continue`? -#### An open-source framework to accelerate your use of models like GPT-4 while coding +**`Continue` is the open-source library for accelerating your use of LLMs while coding.** -1. Leverage steps created by others in your workflows as you code. -2. Customize steps and compose them together to fit your workflows. -3. Review, reverse, and rerun steps to use models with confidence. +You define the scenarios where Large Language Models ([LLMs](./concepts/llm.md)) like GPT-4 and StarCoder should act as an autopilot that helps you complete software development tasks. You use [recipes](./concepts/recipe.md) created by others to automate more steps in your development 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 also review, reverse, and rerun [steps](./concepts/step.md) with the [Continue GUI](./concepts/gui.md), which helps guide the work done by LLMs and learn when to use and trust them. -## How Continue works +## Why do developers use `Continue`? -The Continue framework consists of a `SDK`, a `GUI`, and a `Core` that brings everything together. +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, this is quite a painful experience because of how much manual copy, paste, and editing is required to construct context for LLMs and then incorporate the generations from LLMs. Many other developers prefer to use open source models or work at organizations where they are unable to use ChatGPT, so they are using [StarCoder](https://huggingface.co/blog/starcoder) [Chat](https://huggingface.co/chat/) and running into the same issues. -The `SDK` gives you access to tools (e.g. open a directory, edit a file, call an LLM, etc), which you can use when defining how a step should work and composing them with other steps. +`Continue` eliminates the manual copy, paste, and editing required when using LLMs while coding. This 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. -The `GUI` enables you to guide steps and makes everything transparent, so you can review all steps that were automated, giving you the opportunity to undo and rerun any that ran incorrectly. +## Getting started -The `Core` connects the SDK and GUI with the IDE (i.e. in VS Code, a web browser, etc), enabling the steps to make changes to your code and accelerate your software development workflows.
\ No newline at end of file +1. Try out `Continue` in the [GitHub Codespaces Demo](./getting-started.md) +2. Install `Continue` packaged as a [VS Code extension](./install.md)
\ No newline at end of file diff --git a/docs/docs/sdk.md b/docs/docs/sdk.md deleted file mode 100644 index c7e10e85..00000000 --- a/docs/docs/sdk.md +++ /dev/null @@ -1 +0,0 @@ -# SDK
\ No newline at end of file diff --git a/docs/docs/telemetry.md b/docs/docs/telemetry.md index cf53d631..be0c7666 100644 --- a/docs/docs/telemetry.md +++ b/docs/docs/telemetry.md @@ -1 +1,17 @@ -# Telemetry
\ No newline at end of file +# Telemetry
+
+## Overview
+
+`Continue` collects and reports **anonymous** usage information. This data is essential to understanding how we should improve the library. You can opt out of it at any time.
+
+## What we track
+
+We track the following...
+
+*TODO: Detail exactly what we track*
+
+## How to opt out
+
+Here are the instructions for turning off telemetry...
+
+*TODO: Describe step-by-step how to opt out of telemetry*
\ 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 21d937b5..74800531 100644 --- a/docs/docs/walkthroughs/create-a-recipe.md +++ b/docs/docs/walkthroughs/create-a-recipe.md @@ -1,4 +1,6 @@ -# Create a Recipe
+# Create a recipe
+
+*TODO: Describe step-by-step how to create a recipe*
## 1. Create a step
@@ -48,7 +50,9 @@ class SetUpVenvStep(Step): await sdk.run("python3 -m venv env && source env/bin/activate") # MacOS and Linux
```
-## 2. Compose steps together
+## 2. Compose steps together into a complete recipe
+
+R
By convention, the name of every recipe ends with `Recipe`.
diff --git a/docs/docs/walkthroughs/share-a-recipe.md b/docs/docs/walkthroughs/share-a-recipe.md index 4082d207..1d5e2f60 100644 --- a/docs/docs/walkthroughs/share-a-recipe.md +++ b/docs/docs/walkthroughs/share-a-recipe.md @@ -1 +1,3 @@ -# Share a recipe
\ No newline at end of file +# Share a recipe
+
+*TODO: Describe step-by-step how to share a recipe*
\ No newline at end of file diff --git a/docs/docs/walkthroughs/use-a-recipe.md b/docs/docs/walkthroughs/use-a-recipe.md index 40dc9da1..fc653eea 100644 --- a/docs/docs/walkthroughs/use-a-recipe.md +++ b/docs/docs/walkthroughs/use-a-recipe.md @@ -1 +1,3 @@ -# Use a Recipe
\ No newline at end of file +# Use a recipe
+
+*TODO: Describe step-by-step how to use a recipe*
\ No newline at end of file diff --git a/docs/docs/walkthroughs/use-the-gui.md b/docs/docs/walkthroughs/use-the-gui.md index cfd5f214..a7263159 100644 --- a/docs/docs/walkthroughs/use-the-gui.md +++ b/docs/docs/walkthroughs/use-the-gui.md @@ -1 +1,3 @@ -# Use the GUI
\ No newline at end of file +# Use the GUI
+
+*TODO: Describe step-by-step how to use the `Continue GUI`*
\ No newline at end of file |