smallcloudai · JegernOUTT · Dec 23, 2025 · May 28, 2025 · May 29, 2025 · May 30, 2025
diff --git a/.github/workflows/agent_gui_build.yml b/.github/workflows/agent_gui_build.yml
@@ -4,12 +4,12 @@ on:
   push:
     branches: [main, dev]
     paths:
-      - 'refact-agent/gui/**'
-      - '.github/workflows/agent_gui_*'
+      - "refact-agent/gui/**"
+      - ".github/workflows/agent_gui_*"
   pull_request:
     paths:
-      - 'refact-agent/gui/**'
-      - '.github/workflows/agent_gui_*'
+      - "refact-agent/gui/**"
+      - ".github/workflows/agent_gui_*"
   workflow_dispatch:
 
 defaults:
@@ -31,16 +31,16 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: refact-agent/gui/package-lock.json
 
-      # Disable Husky install during npm ci
+      # Disable Husky install during npm install --prefer-offline
       - name: Install dependencies
         run: |
           sudo apt update
           sudo apt install -y libcairo2-dev libjpeg-dev libpango1.0-dev libgif-dev librsvg2-dev
           npm pkg delete scripts.prepare
-          npm ci
+          npm install --prefer-offline
 
       - run: npm run test
       - run: npm run format:check

diff --git a/docs/.astro/types.d.ts b/docs/.astro/types.d.ts
@@ -409,13 +409,6 @@ declare module 'astro:content' {
   collection: "docs";
   data: InferEntrySchema<"docs">
 } & { render(): Render[".md"] };
-"guides/usage-based-pricing.md": {
-	id: "guides/usage-based-pricing.md";
-  slug: "guides/usage-based-pricing";
-  body: string;
-  collection: "docs";
-  data: InferEntrySchema<"docs">
-} & { render(): Render[".md"] };
 "guides/version-specific/enterprise/getting-started.md": {
 	id: "guides/version-specific/enterprise/getting-started.md";
   slug: "guides/version-specific/enterprise/getting-started";
@@ -500,6 +493,13 @@ declare module 'astro:content' {
   collection: "docs";
   data: InferEntrySchema<"docs">
 } & { render(): Render[".md"] };
+"introduction/usage-based-pricing.md": {
+	id: "introduction/usage-based-pricing.md";
+  slug: "introduction/usage-based-pricing";
+  body: string;
+  collection: "docs";
+  data: InferEntrySchema<"docs">
+} & { render(): Render[".md"] };
 "privacy.md": {
 	id: "privacy.md";
   slug: "privacy";

diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -351,10 +351,10 @@ export default defineConfig({
           }
         },
         {
-          label: 'BYOK',
+          label: 'Configure Providers (BYOK)',
           link: '/byok/',
           attrs: {
-            'aria-label': 'Learn about Bring Your Own Key (BYOK)'
+            'aria-label': 'Configure Providers (BYOK) documentation'
           }
         },
         {

diff --git a/docs/src/assets/byok.png b/docs/src/assets/byok.png
diff --git a/docs/src/assets/byok_login_start.png b/docs/src/assets/byok_login_start.png
diff --git a/docs/src/assets/configure_providers/chat_model_configuration_dialog.png b/docs/src/assets/configure_providers/chat_model_configuration_dialog.png
diff --git a/docs/src/assets/byok_2.png → ...s/configure_providers/choose_provider.png b/docs/src/assets/byok_2.png → ...s/configure_providers/choose_provider.png
diff --git a/docs/src/assets/configure_providers/completion_model_configuration_dialog.png b/docs/src/assets/configure_providers/completion_model_configuration_dialog.png
diff --git a/docs/src/assets/byok_1.png → ...re_providers/configure_providers_menu.png b/docs/src/assets/byok_1.png → ...re_providers/configure_providers_menu.png
diff --git a/docs/src/assets/configure_providers/provider_configuration.png b/docs/src/assets/configure_providers/provider_configuration.png
diff --git a/docs/src/content/docs/byok.md b/docs/src/content/docs/byok.md
@@ -1,22 +1,115 @@
 ---
-title: "Bring Your Own Key (BYOK)"
+title: "Configure Providers (BYOK)"
+description: "How to use Bring Your Own Key (BYOK) to connect your own API keys and models in Refact."
 ---
 
-## Introduction
+# Introduction
 
-Bring Your Own Key (BYOK) allows users to specify their API keys and select models for chat, completion, and embedding tasks across different AI platforms. This feature enables seamless integration with various services while maintaining control over API keys.
+The **Configure Providers** feature (also known as BYOK – Bring Your Own Key) allows you to connect your own API keys for supported AI providers, giving you full control over which models you use and how you are billed.
 
-## How to Switch Providers in the Plugin
+---
+
+## What is "Configure Providers" (BYOK)?
+
+- **Bring Your Own Key (BYOK)** lets you use your own API keys for services like OpenAI, Anthropic, DeepSeek, and others, instead of (or in addition to) Refact’s built-in cloud models.
+- This is ideal if you have your own API access, want to use specific models, or need to keep billing and data usage under your own account.
+
+---
+
+## Supported Providers
+
+You can connect API keys for:
+- **OpenAI** (e.g., GPT-3.5, GPT-4, GPT-4o, etc.)
+- **Anthropic** (e.g., Claude models)
+- **DeepSeek** (e.g., deepseek-chat, deepseek-reasoner)
+- **Local models** (if supported by your Refact instance)
+- Other providers as they become available
+
+---
+
+## How to Configure Providers (Step-by-Step)
+
+### 1. Open the Providers Menu
+
+- In the Refact plugin, click the menu button (three horizontal lines or "burger" icon) in the top right corner.
+- Select **Configure Providers** from the dropdown menu.
+
+  ![Configure Providers Menu](../../assets/configure_providers/configure_providers_menu.png)
+
+---
+
+### 2. Add a New Provider
+
+- In the **Configure Providers** window, click **Add Provider** or the "+" button.
+- Choose your provider from the list (e.g., OpenAI, Anthropic, DeepSeek).
+
+  ![Choose Provider](../../assets/configure_providers/choose_provider.png)
+
+---
+
+### 3. Enter Your API Key and Configure Provider Settings
+
+- Paste your API key into the field provided.
+- (Optional) Give the provider a custom name for easy identification.
+- Enable or disable the provider as needed.
+- Click **Save**.
+
+  ![Provider Configuration](../../assets/configure_providers/provider_configuration.png)
 
-By default, your provider is Refact.ai Cloud. If you want to switch from it, follow these steps:
+---
+
+### 4. Configure Models for Each Provider
+
+- For each provider, you can add and configure models for the tasks that provider supports (such as **Chat**, **Completion**, or **Embeddings**).
+- The available model types and settings will depend on the provider you select.
+- Click **Add model** to open the model configuration dialog.
+
+  ![Chat Model Configuration Dialog](../../assets/configure_providers/chat_model_configuration_dialog.png)
+
+  ![Completion Model Configuration Dialog](../../assets/configure_providers/completion_model_configuration_dialog.png)
+
+#### Model Configuration Fields
+- **Name**: The model’s name/ID (e.g., `gpt-4o`, `deepseek-chat`).
+- **Context Window (n_ctx)**: Maximum context length (tokens) the model can handle.
+- **Tokenizer**: The tokenizer to use (e.g., `hf://` for HuggingFace models).
+- **Default Temperature**: Controls randomness/creativity of model outputs.
+- **Reasoning Style**: (Dropdown) Choose a reasoning style, if supported.
+- **Capabilities**: Select which features the model supports (Tools, Multimodality, Clicks, Agent, etc.).
+
+---
+
+### 5. Switch Between Providers and Models
+
+- You can add multiple providers and models, and switch between them at any time.
+- The currently active provider/model will be used for new requests.
+
+---
 
-1. Navigate to the "Burger" button in the right upper corner of the plugin interface and click it.
-2. Go to the "Configure providers" tab and click it.<br>
-   <img src="../../assets/byok_1.png" alt="Configure providers tab" style="max-height:33vh; display:block; margin:1em 0; border:3px solid #e74c3c; border-radius:8px;">
-3. Choose the provider you want to add from the list.<br>
-   <img src="../../assets/byok_2.png" alt="Choose provider" style="max-height:33vh; display:block; margin:1em 0; border:3px solid #e74c3c; border-radius:8px;">
-4. You can enable or disable providers and delete them if needed.
+## Billing and Usage
 
-## Additional Resources
+- **When using BYOK, your requests are billed directly by the provider (e.g., OpenAI, Anthropic, DeepSeek).**
+- **Refact coins are NOT consumed** for BYOK requests.
+- You are responsible for monitoring your API usage and costs with your provider.
+
+---
+
+## Best Practices & Troubleshooting
+
+- **Keep your API keys secure.** Never share them publicly.
+- If a provider or model is not working, double-check your API key, model name, and account status.
+- Some providers may have usage limits or require specific permissions.
+- For help, visit our [Discord Community](https://smallcloud.ai/discord) or check the FAQ.
+
+---
+
+## FAQ
+
+**Q: Can I use multiple providers at once?**  
+A: Yes! You can add and switch between multiple providers as needed.
+
+**Q: What happens if my API key runs out of credit?**  
+A: Requests will fail until you add more credit or switch to another provider.
+
+---
 
-For more examples and configurations, please visit the [Refact GitHub repository](https://github.com/smallcloudai/refact-lsp/tree/main/bring_your_own_key).
+For more help, see our [FAQ](/faq/) or contact support.
diff --git a/docs/src/content/docs/introduction/usage-based-pricing.md b/docs/src/content/docs/introduction/usage-based-pricing.md
@@ -120,10 +120,11 @@ showDollarsBtn.onclick = () => setTable('dollars');
 | Self-hosting option available | |
 | Discord support | |
 
-## Bring Your Own Key (BYOK)
+## Configure Providers (BYOK)
 
-If you prefer to use your own API key (for OpenAI, Anthropic, or local models), you can connect it to Refact.ai. When using BYOK, requests are billed by your provider and do not consume Refact.ai coins.
+Refact.ai allows you to connect your own API keys for OpenAI, Anthropic, DeepSeek, and other providers using the **Configure Providers** feature (also known as BYOK – Bring Your Own Key). This gives you full control over which models you use and how you are billed.
 
 **No commission:** For now, Refact.ai does not take any commission or markup on API usage. You pay only for the actual API cost of the model you use.
 
-For more information on how to use Bring Your Own Key (BYOK), see the [BYOK documentation](https://github.com/smallcloudai/refact/blob/main/docs/byok.md) in the repository.
+For a step-by-step guide on setting up and using this feature, see the [Configure Providers (BYOK) documentation](/byok/).
+