diff --git a/docs/docs/guides/07-integrations/01-integrate-continue.mdx b/docs/docs/guides/07-integrations/01-integrate-continue.mdx new file mode 100644 index 000000000..bfb860b2d --- /dev/null +++ b/docs/docs/guides/07-integrations/01-integrate-continue.mdx @@ -0,0 +1,111 @@ +--- +title: Integrate Continue with Jan and VSCode +slug: /guides/integrations/continue +description: Guide to integrate Continue with Jan and VSCode +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + Continue integration, + VSCode integration, + ] +--- + +{/* Imports */} +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + +## Quick Introduction + +[Continue](https://continue.dev/docs/intro) is an open-source autopilot for VS Code and JetBrains—the easiest way to code with any LLM. + +In this guide, we will show you how to integrate Continue with Jan and VSCode, enhancing your coding experience with the power of the local AI language model. + +## Steps to Integrate Continue with Jan and VSCode + +### 1. Install Continue for VSCode + +You need to install Continue for VSCode. You can follow this [guide to install Continue for VSCode](https://continue.dev/docs/quickstart). + +### 2. Enable Jan API Server + +To configure the Continue to use Jan's Local Server, you need to enable Jan API Server with your preferred model, please follow this [guide to enable Jan API Server](../05-using-server/01-server.md) + +### 3. Configure Continue to Use Jan's Local Server + +Navigate to the `~/.continue` directory. + + + + + ```sh + cd ~/.continue + ``` + + + + + ```sh + C:/Users//.continue + ``` + + + + + ```sh + cd ~/.continue + ``` + + + + +Edit the `config.json` file and include the following configuration. + +```json title="~/.continue/config.json" +{ + "models": [ + { + // highlight-next-line + "title": "Jan", + "provider": "openai", + // highlight-start + "model": "mistral-ins-7b-q4", + "apiKey": "EMPTY", + "apiBase": "http://localhost:1337" + // highlight-end + } + ] +} +``` + +- Ensure that the `provider` is `openai`. +- Ensure that the `model` is the same as the one you enabled in the Jan API Server. +- Ensure that the `apiBase` is `http://localhost:1337`. +- Ensure that the `apiKey` is `EMPTY`. + +### 4. Ensure the Using Model Is Activated in Jan + +Navigate to `Settings` > `Models`. Activate the model that you want to use in Jan by clicking the **three dots (⋮)** and **start model**. + +![Active Models](assets/01-start-model.png) + +### 5. Try Out the Integration of Jan and Continue in Vscode + +#### Asking questions about the code + +- Highlight a code snippet and press `Command + Shift + M` to open the **Left Panel**. +- Select Jan at the bottom and ask a question about the code, for example, `Explain this code`. + +![Continue Interactions](assets/01-continue-ask.png) + +#### Editing the code with the help of a large language model + +- Highlight a code snippet and press `Command + Shift + L` and input your edit request, for example, `Write comments for this code`. + +![Continue Edit Code](assets/01-continue-edit-demo.gif) diff --git a/docs/docs/guides/07-integrations/README.mdx b/docs/docs/guides/07-integrations/README.mdx new file mode 100644 index 000000000..90ca2c1d5 --- /dev/null +++ b/docs/docs/guides/07-integrations/README.mdx @@ -0,0 +1,21 @@ +--- +title: Integrations +slug: /guides/integrations/ +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + troubleshooting, + ] +--- + +import DocCardList from "@theme/DocCardList"; + + diff --git a/docs/docs/guides/07-integrations/assets/01-activate-model.png b/docs/docs/guides/07-integrations/assets/01-activate-model.png new file mode 100644 index 000000000..417f4bf3c Binary files /dev/null and b/docs/docs/guides/07-integrations/assets/01-activate-model.png differ diff --git a/docs/docs/guides/07-integrations/assets/01-continue-ask.png b/docs/docs/guides/07-integrations/assets/01-continue-ask.png new file mode 100644 index 000000000..d61c42974 Binary files /dev/null and b/docs/docs/guides/07-integrations/assets/01-continue-ask.png differ diff --git a/docs/docs/guides/07-integrations/assets/01-continue-edit-demo.gif b/docs/docs/guides/07-integrations/assets/01-continue-edit-demo.gif new file mode 100644 index 000000000..743b5d02b Binary files /dev/null and b/docs/docs/guides/07-integrations/assets/01-continue-edit-demo.gif differ diff --git a/docs/docs/guides/07-integrations/assets/01-start-model.png b/docs/docs/guides/07-integrations/assets/01-start-model.png new file mode 100644 index 000000000..bc807a960 Binary files /dev/null and b/docs/docs/guides/07-integrations/assets/01-start-model.png differ diff --git a/docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx b/docs/docs/guides/08-troubleshooting/01-stuck-on-broken-build.mdx similarity index 100% rename from docs/docs/guides/07-troubleshooting/01-stuck-on-broken-build.mdx rename to docs/docs/guides/08-troubleshooting/01-stuck-on-broken-build.mdx diff --git a/docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx b/docs/docs/guides/08-troubleshooting/02-failed-to-fetch.mdx similarity index 100% rename from docs/docs/guides/07-troubleshooting/02-failed-to-fetch.mdx rename to docs/docs/guides/08-troubleshooting/02-failed-to-fetch.mdx diff --git a/docs/docs/guides/07-troubleshooting/03-gpu-not-used.mdx b/docs/docs/guides/08-troubleshooting/03-gpu-not-used.mdx similarity index 100% rename from docs/docs/guides/07-troubleshooting/03-gpu-not-used.mdx rename to docs/docs/guides/08-troubleshooting/03-gpu-not-used.mdx diff --git a/docs/docs/guides/07-troubleshooting/README.mdx b/docs/docs/guides/08-troubleshooting/README.mdx similarity index 100% rename from docs/docs/guides/07-troubleshooting/README.mdx rename to docs/docs/guides/08-troubleshooting/README.mdx