Create separate integrations section (#65)

* Move integrations to their own section
* Make sure every run command has a volume

Author: danbarr

.gitignore

@@ -18,3 +18,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.vercel

docs/about/changelog.md

@@ -13,20 +13,20 @@ Major features and changes are noted here. To review all updates, see the
 
 Related: [Upgrade CodeGate](../how-to/install.md#upgrade-codegate)
 
-- **Cline support** - 28 Jan, 2025\
-  CodeGate version 0.1.14 adds support for
-  [Cline](https://github.com/cline/cline) with Anthropic, OpenAI, Ollama, and LM
-  Studio. See the [how-to guide](../how-to/use-with-cline.mdx) to learn more.
+- **New integration: Cline** - 28 Jan, 2025\
+  CodeGate version 0.1.14 adds support for [Cline](https://cline.bot/) with
+  Anthropic, OpenAI, Ollama, and LM Studio. See the
+  [integration guide](../integrations/cline.mdx) to learn more.
 
 - **Workspaces** - 22 Jan, 2025\
   Now available in CodeGate v0.1.12, workspaces help you organize and customize
   your AI-assisted development. Learn more in
   [Workspaces](../features/workspaces.mdx).
 
-- **Aider support** - 13 Jan, 2025\
+- **New integration: aider** - 13 Jan, 2025\
   CodeGate version 0.1.6 adds support for [aider](https://aider.chat/), an AI
   pair programmer in your terminal. See the
-  [how-to guide](../how-to/use-with-aider.mdx) to learn more.
+  [integration guide](../integrations/aider.mdx) to learn more.
 
 - **Semantic versioning for container image** - 8 Jan, 2025\
   Starting with v0.1.4, the CodeGate container image is published with semantic
@@ -35,11 +35,12 @@ Related: [Upgrade CodeGate](../how-to/install.md#upgrade-codegate)
   optionally pull using the major (`v0`), minor (`v0.1`), or patch version
   (`v0.1.4`) to explicitly control the version you're running. \
   CodeGate is evolving quickly, so we still recommend pulling the `latest` tag
-  so you don't miss out on new features and updates to package risk data.
+  so you don't miss out on the newest features and updates.
 
 - **UI port change** - 7 Jan, 2025\
   The internal port for the dashboard UI has changed from 80 to 9090 to resolve
   a permissions issue for Linux users.
 
-- **Introducing CodeGate** - 17 Dec, 2024\
-  Initial public launch of CodeGate!
+- **Introducing CodeGate!** - 17 Dec, 2024\
+  Initial public launch of CodeGate, with support for Continue and GitHub
+  Copilot.

docs/about/contributing.md

@@ -1,6 +1,6 @@
 ---
 title: Contributing
-description: How to contribute to the project.
+description: How to contribute to CodeGate
 sidebar_position: 30
 ---
 
@@ -25,7 +25,13 @@ general usage question, please ask in the `#codegate` channel on
 create a new issue in the
 [CodeGate GitHub repository](https://github.com/stacklok/codegate/issues).
 
-## Contributing code
+## Contributing code or docs
+
+CodeGate's code and docs are managed in several repositories:
+
+- Main repo: https://github.com/stacklok/codegate
+- Dashboard UI: https://github.com/stacklok/codegate-ui
+- Docs: https://github.com/stacklok/codegate-docs
 
 If you've found an issue you'd like to work on, you can contribute code to
 CodeGate by submitting a pull request. Before you submit a pull request, please

docs/about/faq.md

@@ -1,14 +1,14 @@
 ---
 title: Frequently asked questions
-description: Frequently asked questions about the CodeGate project.
+description: Frequently asked questions about the CodeGate project
 sidebar_label: FAQ
 sidebar_position: 10
 ---
 
-### Does CodeGate replace my AI code assistant plugin?
+### Does CodeGate replace my AI coding assistant or agent?
 
-No, CodeGate works _with_ your AI code assistant, as a local intermediary
-between your client and the LLM it's communicating with.
+No, CodeGate works _with_ your AI coding tool, as a local intermediary between
+your client and the LLM it's communicating with.
 
 ### Does CodeGate work with any other IDE plugins or coding assistants?
 

docs/about/index.mdx

@@ -1,6 +1,6 @@
 ---
 title: About CodeGate
-description: More information about the CodeGate project.
+description: Learn more about the CodeGate project
 ---
 
 import DocCardList from '@theme/DocCardList';

docs/features/_category_.yaml

@@ -1,3 +1,2 @@
 label: 'Features'
 position: 30
-collapsed: false

docs/how-to/configure.md

@@ -7,12 +7,13 @@ sidebar_position: 20
 ## Customize CodeGate's behavior
 
 The CodeGate container runs with default settings to support Ollama, Anthropic,
-and OpenAI APIs with typical settings. To customize the behavior, you can supply
+and OpenAI APIs with typical settings. To customize the behavior, you can add
 extra configuration parameters to the container as environment variables:
 
 ```bash {2}
 docker run --name codegate -d -p 8989:8989 -p 9090:9090 \
   [-e KEY=VALUE ...] \
+  --mount type=volume,src=codegate_volume,dst=/app/codegate_volume \
   --restart unless-stopped ghcr.io/stacklok/codegate
 ```
 
@@ -41,9 +42,11 @@ To use OpenRouter, set the vLLM URL when you launch CodeGate:
 ```bash {2}
 docker run --name codegate -d -p 8989:8989 -p 9090:9090 \
   -e CODEGATE_VLLM_URL=https://openrouter.ai/api \
+  --mount type=volume,src=codegate_volume,dst=/app/codegate_volume \
   --restart unless-stopped ghcr.io/stacklok/codegate
 ```
 
-Then, [configure the Continue IDE plugin](./use-with-continue.mdx) to access the
-vLLM endpoint (`http://localhost:8989/vllm/`) along with the model you'd like to
-use and your OpenRouter API key.
+Then,
+[configure the Continue IDE plugin](../integrations/continue.mdx?provider=vllm)
+to use CodeGate's vLLM endpoint (`http://localhost:8989/vllm`) along with the
+model you'd like to use and your OpenRouter API key.

docs/how-to/dashboard.md

@@ -16,6 +16,7 @@ system when you launch CodeGate, for example:
 ```bash {2}
 docker run --name codegate -d -p 8989:8989 \
   -p 9090:9090 \
+  --mount type=volume,src=codegate_volume,dst=/app/codegate_volume \
   --restart unless-stopped ghcr.io/stacklok/codegate:latest
 ```
 
@@ -36,10 +37,9 @@ browser.
 
 ## Persisting dashboard data {#persisting-dashboard-data}
 
-To retain your prompt history and other dashboard metrics between restarts,
+To retain your prompt history and workspace configurations between restarts,
 mount a persistent
 [Docker volume](https://docs.docker.com/engine/storage/volumes/) to the CodeGate
-container. The volume destination must be `/app/codegate_volume` inside the
 container. This example creates a volume named `codegate_volume`:
 
 ```bash {2}

docs/how-to/install.md

@@ -27,10 +27,13 @@ docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount typ
 
 Parameter reference:
 
+- `--name codegate` - give the container a friendly name for easy reference
 - `-d` - start in detached (background) mode
-- `-p 8989:8989` - bind the CodeGate API to port 8989 on your host
+- `-p 8989:8989` - bind the CodeGate API to port 8989 on your host (required)
 - `-p 9090:9090` - bind the CodeGate web dashboard to port 9090 on your host
+  (recommended)
 - `-p 8990:8990` - bind the CodeGate secure HTTP proxy to port 8990 on your host
+  (required for Copilot)
 - `--mount ...` - mount a persistent Docker volume named `codegate_volume` to
   the required path in the container
 - `--restart unless-stopped` - restart CodeGate after a Docker or system
@@ -40,33 +43,34 @@ More example run commands to run the container with the right parameters for
 your scenario are found below. To learn how to customize the CodeGate
 application settings, see [Configure CodeGate](./configure.md)
 
-### Alternative run commands {#examples}
+:::warning
 
-Run with minimal functionality for use with **Continue**, **aider**, or
-**Cline**:
+If you omit the persistent volume mount, your
+[workspace configurations](../features/workspaces.mdx) and prompt history are
+lost when you stop or restart CodeGate.
 
-```bash
-docker run -d -p 8989:8989 -p 9090:9090 --restart unless-stopped ghcr.io/stacklok/codegate:latest
-```
+:::
+
+### Alternative run commands {#examples}
 
-**Mount a persistent volume** to the container (see
-[Persisting dashboard data](./dashboard.md#persisting-dashboard-data)):
+Run with minimal functionality for use with **Continue**, **aider**, or
+**Cline** (omits the HTTP proxy port needed by Copilot):
 
 ```bash
 docker run --name codegate -d -p 8989:8989 -p 9090:9090 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
 ```
 
-**Copilot support:** enable the HTTP proxy port and mount a persistent volume
-(see [Use CodeGate with GitHub Copilot](./use-with-copilot.mdx)):
+**Restrict ports:** Docker publishes ports to all interfaces on your host by
+default. This example publishes only on your `localhost` interface:
 
 ```bash
-docker run --name codegate -d -p 8989:8989 -p 9090:9090 -p 8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
+docker run --name codegate -d -p 127.0.0.1:8989:8989 -p 127.0.0.1:9090:9090 -p 127.0.0.1:8990:8990 --mount type=volume,src=codegate_volume,dst=/app/codegate_volume --restart unless-stopped ghcr.io/stacklok/codegate:latest
 ```
 
 **Install a specific version:** starting with v0.1.4 you can optionally run a
 specific version of CodeGate using sematic version tags:
 
-- Patch version: `ghcr.io/stacklok/codegate:v0.1.4` (exact)
+- Patch version: `ghcr.io/stacklok/codegate:v0.1.15` (exact)
 - Minor version: `ghcr.io/stacklok/codegate:v0.1` (latest v0.1.x release)
 - Major version: `ghcr.io/stacklok/codegate:v0` (latest v0.x.x release)
 
@@ -91,12 +95,20 @@ CodeGate listens on several network ports:
 | 8989              | 8989                      | CodeGate API                                   |
 | 8990              | 8990                      | Secure HTTP proxy (GitHub Copilot integration) |
 
+Docker publishes ports to all network interfaces on your system by default. This
+can unintentionally expose your CodeGate installation to other systems on the
+same network. To restrict this, add `127.0.0.1` IP to the publish flags:
+
+- API: `-p 127.0.0.1:8989:8989`
+- HTTPS proxy: `-p 127.0.0.1:8990:8990`
+- Dashboard: `-p 127.0.0.1:9090:9090`
+
 All of the commands in these docs assume the default ports. To use different
 listening ports, modify the `-p` flag(s):
 
+- API: `-p YOUR_PORT:8989`
+- HTTPS proxy: `-p YOUR_PORT:8990`
 - Dashboard: `-p YOUR_PORT:9090`
-- CodeGate API: `-p YOUR_PORT:8989`
-- Secure HTTP proxy: `-p YOUR_PORT:8990`
 
 :::note
 
@@ -149,19 +161,16 @@ persistent volume.
 
 ## Next steps
 
-Now that CodeGate is running, proceed to configure your IDE integration.
-
-- [Use CodeGate with aider](./use-with-aider.mdx)
-- [Use CodeGate with Cline](./use-with-cline.mdx)
-- [Use CodeGate with Continue](./use-with-continue.mdx)
-- [Use CodeGate with GitHub Copilot](./use-with-copilot.mdx)
+Now that CodeGate is running, proceed to
+[configure your AI assistant/agent](../integrations/index.mdx).
 
 ## Remove CodeGate
 
-If you decide to stop using CodeGate, follow the removal steps for your IDE
-integration:
+If you decide to stop using CodeGate, follow the removal steps for your
+[integration](../integrations/index.mdx), then stop and remove the CodeGate
+container and volume:
 
-- [Remove CodeGate - aider](./use-with-aider.mdx#remove-codegate)
-- [Remove CodeGate - Cline](./use-with-cline.mdx#remove-codegate)
-- [Remove CodeGate - Continue](./use-with-continue.mdx#remove-codegate)
-- [Remove CodeGate - GitHub Copilot](./use-with-copilot.mdx#remove-codegate)
+```bash
+docker stop codegate && docker rm codegate
+docker volume rm codegate_volume
+```

docs/index.md

@@ -37,10 +37,10 @@ CodeGate supports several development environments and AI providers.
 
 AI coding assistants / IDEs:
 
-- **[GitHub Copilot](./how-to/use-with-copilot.mdx)** with Visual Studio Code
+- **[GitHub Copilot](./integrations/copilot.mdx)** with Visual Studio Code
   (JetBrains coming soon!)
 
-- **[Continue](./how-to/use-with-continue.mdx)** with Visual Studio Code and
+- **[Continue](./integrations/continue.mdx)** with Visual Studio Code and
   JetBrains IDEs
 
   CodeGate supports the following AI model providers with Continue:
@@ -54,10 +54,9 @@ AI coding assistants / IDEs:
     - Anthropic
     - OpenAI
 
-- **[Aider](./how-to/use-with-aider.mdx)** with Ollama and OpenAI-compatible
-  APIs
+- **[Aider](./integrations/aider.mdx)** with Ollama and OpenAI-compatible APIs
 
-- **[Cline](./how-to/use-with-cline.mdx)** with Visual Studio Code
+- **[Cline](./integrations/cline.mdx)** with Visual Studio Code
 
   CodeGate supports Ollama, Anthropic, OpenAI-compatible APIs, and LM Studio
   with Cline.