diff options
author | Ty Dunn <ty@tydunn.com> | 2023-06-16 15:45:07 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-16 15:45:07 -0700 |
commit | 3aa4f014608c09b8da2f4ab95137a959487af245 (patch) | |
tree | b036c362579ef4a9d2085903e1c9b191742e54f5 | |
parent | 472984ab63461b90cf41b645e49bcc95bdf2ef1e (diff) | |
parent | 9f756539fa80422942f220ebd81621dda302f036 (diff) | |
download | sncontinue-3aa4f014608c09b8da2f4ab95137a959487af245.tar.gz sncontinue-3aa4f014608c09b8da2f4ab95137a959487af245.tar.bz2 sncontinue-3aa4f014608c09b8da2f4ab95137a959487af245.zip |
Merge pull request #103 from continuedev/docs
Iterating on the docs
-rw-r--r-- | docs/docs/getting-started.md | 7 | ||||
-rw-r--r-- | docs/docs/install.md | 7 | ||||
-rw-r--r-- | docs/docs/intro.md | 4 | ||||
-rw-r--r-- | docs/docusaurus.config.js | 10 | ||||
-rw-r--r-- | docs/sidebars.js | 1 | ||||
-rw-r--r-- | docs/src/components/HomepageFeatures/index.js | 15 | ||||
-rw-r--r-- | docs/static/img/codespaces-install.png | bin | 0 -> 499343 bytes | |||
-rw-r--r-- | docs/static/img/vscode-install.png | bin | 0 -> 317438 bytes | |||
-rw-r--r-- | extension/package.json | 2 |
9 files changed, 18 insertions, 28 deletions
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index 9824aadd..b7401106 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -12,10 +12,9 @@ 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: Nate to add a screenshot of what Codespaces + Continue looks like when it is ready**
+![codespaces-install](/img/codespaces-install.png)
## Next Steps
- 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)
-
- If you're ready to download for VS Code, you can do so [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue).
+ - 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)
+ - If you're ready to download for VS Code, you can do so [here](https://marketplace.visualstudio.com/items?itemName=Continue.continue)
\ No newline at end of file diff --git a/docs/docs/install.md b/docs/docs/install.md index a042739f..ac0aef30 100644 --- a/docs/docs/install.md +++ b/docs/docs/install.md @@ -12,7 +12,7 @@ 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: Nate to add a screenshot of what Codespaces + Continue looks like when it is ready**
+![vscode-install](/img/vscode-install.png)
You can also open the Continue GUI with `cmd+shift+p` on Mac / `ctrl+shift+p` on Windows and then selecting `Continue: Open GUI`
@@ -22,7 +22,4 @@ If you would like to install Continue from source, please [follow the instructio ## Next steps
-**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 +- Read the `Getting Started` section of the `README.md` [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 e7d922c2..6795797e 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -11,10 +11,10 @@ **Continue is the open-source library for accelerating software development with language models** -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. +You determine when Large Language Models (LLMs) like GPT-4 should act as an autopilot, helping you complete software development tasks. You open a file or highlight some code and then use slash commands like `/edit`, `/explain`, and `/comment` and naturual language instructions to tell the language model what to do. If an error or exception occurs when you run Python or JavaScript code, Continue will automatically tell you in plain English what to try to address it. You can also 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? -Many developers have begun to use [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5) and [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 provide the necessary 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 [GPT-3.5](https://platform.openai.com/docs/models/gpt-3-5) and [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 provide the necessary context and incorporate the generated solutions and advice into your codebase. Continue eliminates this pain by enabling LLMs to natively act in your IDE as you complete your 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 diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 7b817bb9..7746a87b 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -36,21 +36,19 @@ const config = { presets: [ [ "classic", - { - gtag: { - trackingID: 'G-M3JWW8N2XQ', - }, - }, /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { routeBasePath: '/', sidebarPath: require.resolve("./sidebars.js"), - editUrl: "https://github.com/continuedev/continue/", + editUrl: "https://github.com/continuedev/continue/tree/main/docs", }, theme: { customCss: require.resolve("./src/css/custom.css"), }, + gtag: { + trackingID: 'G-M3JWW8N2XQ', + }, }), ], ], diff --git a/docs/sidebars.js b/docs/sidebars.js index 30b8ad3a..f9a5bdef 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -17,7 +17,6 @@ const sidebars = { "intro", "getting-started", "install", - "catalog", "how-continue-works", "telemetry", ], diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js index 31df2b27..6348f80a 100644 --- a/docs/src/components/HomepageFeatures/index.js +++ b/docs/src/components/HomepageFeatures/index.js @@ -4,32 +4,29 @@ import styles from "./styles.module.css"; const FeatureList = [ { - title: "Tell LLMs when to step in", + title: "Understand and edit code", Svg: require("@site/static/img/undraw_docusaurus_mountain.svg").default, description: ( <> - Seamlessly put your repetitive software development tasks - on autopilot by leveraging recipes created by others + Seamlessly ask language models to help you complete steps in your software development tasks </> ), }, { - title: "Write your own recipes", + title: "Customizable for your team", Svg: require("@site/static/img/undraw_docusaurus_tree.svg").default, description: ( <> - Use the Continue SDK to create custom steps and compose - them into recipes, guiding LLMs through common tasks + Define when and how LLMs should act to accelerate steps in your team-specific workflows </> ), }, { - title: "Wield LLMs with confidence", + title: "Break down your work step-by-step", Svg: require("@site/static/img/undraw_docusaurus_react.svg").default, description: ( <> - Use the Continue GUI to review, reverse, and rerun steps or even - entire recipes, allowing you to build trust in language models + Use the Continue GUI to review, reverse, and rerun steps that LLMs and you have taken together </> ), }, diff --git a/docs/static/img/codespaces-install.png b/docs/static/img/codespaces-install.png Binary files differnew file mode 100644 index 00000000..e960eff1 --- /dev/null +++ b/docs/static/img/codespaces-install.png diff --git a/docs/static/img/vscode-install.png b/docs/static/img/vscode-install.png Binary files differnew file mode 100644 index 00000000..17ac547a --- /dev/null +++ b/docs/static/img/vscode-install.png diff --git a/extension/package.json b/extension/package.json index 3a3927f3..56a522ac 100644 --- a/extension/package.json +++ b/extension/package.json @@ -96,7 +96,7 @@ { "type": "webview", "id": "continue.continueGUIView", - "name": ")", + "name": "GUI", "visibility": "visible" } ] |