diff options
author | Ty Dunn <ty@tydunn.com> | 2023-06-05 09:25:10 +0200 |
---|---|---|
committer | Ty Dunn <ty@tydunn.com> | 2023-06-05 09:25:10 +0200 |
commit | 2fd081971a87b01e8c549bb9fea34e52e65e1bb9 (patch) | |
tree | 17ab00dffdb9a42827962f57eaf407615c0529f2 | |
parent | 0930f7048c9fcf5836cbee92e37a95f45693ded8 (diff) | |
download | sncontinue-2fd081971a87b01e8c549bb9fea34e52e65e1bb9.tar.gz sncontinue-2fd081971a87b01e8c549bb9fea34e52e65e1bb9.tar.bz2 sncontinue-2fd081971a87b01e8c549bb9fea34e52e65e1bb9.zip |
direction change
-rw-r--r-- | docs/docs/catalog.md | 12 | ||||
-rw-r--r-- | docs/docs/getting-started.md | 12 | ||||
-rw-r--r-- | docs/docs/install.md | 21 | ||||
-rw-r--r-- | docs/docs/intro.md | 2 | ||||
-rw-r--r-- | docs/sidebars.js | 29 |
5 files changed, 14 insertions, 62 deletions
diff --git a/docs/docs/catalog.md b/docs/docs/catalog.md index b9e223e2..7dbcb547 100644 --- a/docs/docs/catalog.md +++ b/docs/docs/catalog.md @@ -2,9 +2,7 @@ ## Steps
-**TODO: better explain each step and link to them, find all in steps folder**
-
-#### EditCodeStep
+### EditCodeStep
Provide a prompt and a list of file ranges to be edited by a language model
@@ -20,14 +18,12 @@ Create a table in TypeORM Create and run an alembic migration
-### WritePytestsRecipe
-
-Write unit tests for this file
-
### AnswerQuestionChromaStep
Type `/ask` and ask any question about your whole codebase. The Chroma embeddings store will help find important snippets and answer your question
## Recipes
-**TODO: add each recipe, explain them, and link to them, find all in recipes folder**
\ No newline at end of file +### WritePytestsRecipe
+
+Write unit tests for this file
\ No newline at end of file diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index ce52bd12..5dad2e43 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -12,16 +12,8 @@ We don't want to waste your time with install and env setup before you try Conti 2. Select the `Create new codespace` button and wait 30-90 seconds while it launches and installs the Continue extension. Once complete, it should look like this:
-**TODO: Add image of Codespaces after it starts up**
-
-3. Read the `Getting Started` section of the `README.md` file that has been opened in your codespace, which you can also find [here](https://github.com/continuedev/continue-codespaces-demo/blob/main/README.md)
+**TODO: Nate to add a screenshot of what Codespaces + Continue looks like when it is ready**
## Next Steps
-If you would like to use Continue locally, you can follow [these steps](./install.md) to install it in VS Code.
-
-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)
-- [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 + Read the `Getting Started` section of the `README.md` file that has been opened in your codespace, which you can also find [here](https://github.com/continuedev/continue-codespaces-demo/blob/main/README.md)
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index 5a56dbab..a042739f 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -12,17 +12,9 @@ If you want to try Continue before installing locally, check out the [GitHub Cod 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. It should look like this when it is complete:
-**TODO: Add link to screenshot of what it looks like after install has completed**
+**TODO: Nate to add a screenshot of what Codespaces + Continue looks like when it is ready**
-You can also open the Continue GUI with `cmd+shift+p` on Mac / `ctrl+shift+p` on Windows and then selecting `Continue: Open Debug Panel`
-
-4. To test a few common recipes, open a blank python file and try the following:
-- Ask it to "write me a calculator class in python"
-- /comment to write comments for the class
-- /pytest to write Pytest unit tests in a separate file
-- Ask in natural language for a new method
-
-**TODO: Can we have one getting started workflow across VS Code and GitHub Codespaces?**
+You can also open the Continue GUI with `cmd+shift+p` on Mac / `ctrl+shift+p` on Windows and then selecting `Continue: Open GUI`
:::note
If you would like to install Continue from source, please [follow the instructions](https://github.com/continuedev/continue/blob/main/README.md) in the repo README.
@@ -30,8 +22,7 @@ If you would like to install Continue from source, please [follow the instructio ## Next steps
-Now that you have installed locally in VS Code, you can learn more with our walkthroughs:
-- [Use the GUI](./walkthroughs/use-the-gui.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 +**TODO: Nate to update VS Code install to have the same getting started as Codespaces**
+
+Read the `Getting Started` section of the `README.md` file that has been opened in VS Code,
+which you can also find [here](https://github.com/continuedev/continue-codespaces-demo/blob/main/README.md)
\ No newline at end of file diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 6a04f678..e7d922c2 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -11,7 +11,7 @@ **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 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. Whether you are using a recipe created by yourself or someone else, you can review, reverse, and rerun steps with the [Continue GUI](./concepts/gui.md), which helps you guide the work done by LLMs and learn when to use and trust them. +You define the scenarios where Large Language Models LLMs like GPT-4 and StarCoder should act as an autopilot, helping you complete software development tasks. You use recipes created by others to automate more steps in your workflows. If a recipe does not exist or work exactly like you want, you can use the Continue SDK to create custom steps and compose them into personalized recipes. Whether you are using a recipe created by yourself or someone else, you can review, reverse, and rerun steps with the Continue GUI, which helps you guide the work done by LLMs and learn when to use and trust them. ## Why do developers use Continue? diff --git a/docs/sidebars.js b/docs/sidebars.js index 6714f6f0..30b8ad3a 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -17,35 +17,8 @@ const sidebars = { "intro", "getting-started", "install", - "how-continue-works", - { - type: "category", - label: "Walkthroughs", - items: [ - "walkthroughs/use-the-gui", - "walkthroughs/use-a-recipe", - "walkthroughs/create-a-recipe", - "walkthroughs/share-a-recipe", - ], - }, - { - type: "category", - label: "Concepts", - items: [ - "concepts/autopilot", - "concepts/credentials", - "concepts/gui", - "concepts/history", - "concepts/ide", - "concepts/llm", - "concepts/policy", - "concepts/recipe", - "concepts/sdk", - "concepts/server", - "concepts/step", - ], - }, "catalog", + "how-continue-works", "telemetry", ], }; |