Merge branch 'main' into feat/new-fonts

Author: wladimiiir

.github/workflows/deploy-docs.yml

@@ -1,6 +1,12 @@
 name: Deploy docs site to GitHub Pages
 
 on:
+  push:
+    paths:
+      - 'docs-site/**'
+  pull_request:
+    paths:
+      - 'docs-site/**'
   workflow_dispatch:
 
 permissions:
@@ -46,6 +52,7 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

.gitignore

@@ -33,4 +33,3 @@ start-docker.sh
 .claude-trace
 repomix-output.txt
 
-docs-site

README.md

@@ -6,12 +6,14 @@
 
 **Elevate your development workflow with AiderDesk**, a sophisticated desktop application bringing all the power of [aider](https://aider.chat) into a user-friendly graphical interface. Whether you're managing multiple projects, integrating with your favorite IDE, or tracking costs, AiderDesk elevates your productivity to new heights.
 
+[📖 Documentation](https://aiderdesk.hotovo.com/docs)
+
 ## 🎬 Overview
 
 See AiderDesk in action:
 
 <div align="center">
-  <a href="https://www.youtube.com/watch?v=9oyIdntCh7g">
+  <a href="https://www.youtube.com/watch?v=g4qg7xTjxcM">
     <img src="https://img.youtube.com/vi/9oyIdntCh7g/0.jpg" alt="AiderDesk Overview Video" width=400>
   </a>
 </div>
@@ -20,28 +22,29 @@ See AiderDesk in action:
 
 AiderDesk is packed with features designed for modern software development:
 
-*   **🖥️ Intuitive GUI**: A clean, visual interface replacing command-line interactions.
-*   **📂 Multi-Project Management**: Seamlessly organize, switch between, and manage multiple codebases.
-*   **🔌 Effortless IDE Integration**: Automatically sync context files with your active editor in:
-  *   IntelliJ IDEA ([Plugin](https://plugins.jetbrains.com/plugin/26313-aiderdesk-connector) | [GitHub](https://github.com/hotovo/aider-desk-connector-intellij-plugin))
-  *   VSCode ([Extension](https://marketplace.visualstudio.com/items?itemName=hotovo-sk.aider-desk-connector) | [GitHub](https://github.com/hotovo/aider-desk-connector-vscode-extension))
-*   **🤖 Powerful Agent Mode**: Utilize an autonomous AI agent (powered by Vercel AI SDK) capable of complex task planning and execution using various tools.
-*   **🧩 Extensible via MCP**: Connect to Model Context Protocol (MCP) servers to grant the Agent access to external tools like web search, documentation lookups, and more.
-*   **✍️ Custom Commands**: Define and execute your own commands to automate tasks and extend AiderDesk's capabilities. [Learn more](docs/custom-commands.md)
-*   **📄 Smart Context Management**: Automatically manage context via IDE plugins or manually control context using the integrated project file browser.
-*   **💾 Robust Session Management**: Save and load entire work sessions (chat history, context files) to easily switch between tasks or resume later.
-*   **🔄 Flexible Model Switching**: Change AI models on the fly while retaining your conversation and context.
-*   **💬 Multiple Chat Modes**: Tailor the AI interaction for different needs (e.g., coding, asking questions).
-*   **🔍 Integrated Diff Viewer**: Review AI-generated code changes with a clear side-by-side comparison.
-*   **⏪ One-Click Reverts**: Easily undo specific AI modifications while keeping others.
-*   **💰 Cost Tracking**: Monitor token usage and associated costs per project session for both Aider and the Agent.
-*   **📊 Usage Dashboard**: Visualize token usage, costs, and model distribution with interactive charts and tables.
-*   **⚙️ Centralized Settings**: Manage API keys, environment variables, and configurations conveniently.
-*   **🌐 Versatile REST API**: Integrate AiderDesk with external tools and workflows.
-*   **📨 Structured Communication**: View prompts, AI responses, agent thoughts, and tool outputs in an organized format.
-*   **📋 Easy Sharing**: Copy code snippets or entire conversations effortlessly.
+* **🖥️ Intuitive GUI**: A clean, visual interface replacing command-line interactions.
+* **📂 Multi-Project Management**: Seamlessly organize, switch between, and manage multiple codebases.
+* **🔌 Effortless IDE Integration**: Automatically sync context files with your active editor in:
+  * IntelliJ IDEA ([Plugin](https://plugins.jetbrains.com/plugin/26313-aiderdesk-connector) | [GitHub](https://github.com/hotovo/aider-desk-connector-intellij-plugin))
+  * VSCode ([Extension](https://marketplace.visualstudio.com/items?itemName=hotovo-sk.aider-desk-connector) | [GitHub](https://github.com/hotovo/aider-desk-connector-vscode-extension))
+* **🤖 Powerful Agent Mode**: Utilize an autonomous AI agent (powered by Vercel AI SDK) capable of complex task planning and execution using various tools.
+* **🧩 Extensible via MCP**: Connect to Model Context Protocol (MCP) servers to grant the Agent access to external tools like web search, documentation lookups, and more.
+* **✍️ Custom Commands**: Define and execute your own commands to automate tasks and extend AiderDesk's capabilities. [Learn more](https://aiderdesk.hotovo.com/docs/core-features/custom-commands)
+* **📄 Smart Context Management**: Automatically manage context via IDE plugins or manually control context using the integrated project file browser.
+* **💾 Robust Session Management**: Save and load entire work sessions (chat history, context files) to easily switch between tasks or resume later.
+* **🔄 Flexible Model Switching**: Change AI models on the fly while retaining your conversation and context.
+* **💬 Multiple Chat Modes**: Tailor the AI interaction for different needs (e.g., coding, asking questions).
+* **🔍 Integrated Diff Viewer**: Review AI-generated code changes with a clear side-by-side comparison.
+* **⏪ One-Click Reverts**: Easily undo specific AI modifications while keeping others.
+* **💰 Cost Tracking**: Monitor token usage and associated costs per project session for both Aider and the Agent.
+* **📊 Usage Dashboard**: Visualize token usage, costs, and model distribution with interactive charts and tables.
+* **⚙️ Centralized Settings**: Manage API keys, environment variables, and configurations conveniently.
+* **🌐 Versatile REST API**: Integrate AiderDesk with external tools and workflows.
+* **📨 Structured Communication**: View prompts, AI responses, agent thoughts, and tool outputs in an organized format.
+* **📋 Easy Sharing**: Copy code snippets or entire conversations effortlessly.
 
 ---
+
 ### 📄 Comprehensive Context File Management
 
 Keep the AI focused on the relevant code with flexible context management options.
@@ -52,10 +55,11 @@ Keep the AI focused on the relevant code with flexible context management option
   </a>
 </div>
 
-1.  **Automatic IDE Sync**: Use the IntelliJ IDEA or VSCode plugins to automatically add/remove the currently active file(s) in your editor to/from the AiderDesk context.
-2.  **Manual Control**: Utilize the "Context Files" sidebar in AiderDesk, which displays your project's file tree. Click files to manually add or remove them from the context, giving you precise control.
+1. **Automatic IDE Sync**: Use the IntelliJ IDEA or VSCode plugins to automatically add/remove the currently active file(s) in your editor to/from the AiderDesk context.
+2. **Manual Control**: Utilize the "Context Files" sidebar in AiderDesk, which displays your project's file tree. Click files to manually add or remove them from the context, giving you precise control.
 
 ---
+
 ### 💾 Session Management
 
 Never lose your work. Save and load complete sessions, including chat history and context files, per project.
@@ -71,6 +75,7 @@ Never lose your work. Save and load complete sessions, including chat history an
 - **Manage Multiple Tasks**: Easily switch between different features, bug fixes, or experiments within the same project.
 
 ---
+
 ### 🤖 Agent Mode & MCP Support
 
 Unlock advanced AI capabilities with AiderDesk's Agent mode. Built on the Vercel AI SDK, the agent can autonomously plan and execute complex tasks by leveraging a customizable set of tools.
@@ -82,6 +87,7 @@ Unlock advanced AI capabilities with AiderDesk's Agent mode. Built on the Vercel
 </div>
 
 #### Agent Capabilities:
+
 - **Tool-Driven**: Functionality is defined by connected tools (MCP servers + built-in Aider interaction).
 - **Autonomous Planning**: Breaks down complex requests into executable steps using available tools.
 - **Seamless Aider Integration**: Uses Aider for core coding tasks like generation and modification.
@@ -90,7 +96,7 @@ Unlock advanced AI capabilities with AiderDesk's Agent mode. Built on the Vercel
 
 #### 🛠️ Extending Capabilities with MCP
 
-Connect AiderDesk to [Model Context Protocol](https://github.com/model-context-protocol/mcp) (MCP) servers to significantly enhance the Agent's abilities. MCP allows AI models to interact with external tools (web browsers, documentation systems, custom utilities).
+Connect AiderDesk to [Model Context Protocol](https://modelcontextprotocol.io/docs/getting-started/intro) (MCP) servers to significantly enhance the Agent's abilities. MCP allows AI models to interact with external tools (web browsers, documentation systems, custom utilities).
 
 - **Access External Tools**: Grant the agent capabilities beyond built-in functions.
 - **Gather Richer Context**: Enable the agent to fetch external information before instructing Aider.
@@ -99,6 +105,7 @@ Connect AiderDesk to [Model Context Protocol](https://github.com/model-context-p
 AiderDesk is compatible with any MCP server, allowing you to tailor the agent's toolset precisely to your needs.
 
 ---
+
 ### 🌐 REST API
 
 AiderDesk provides a REST API for external tools to interact with the application. The API is running on the same port as the main application (default 24337, configurable by `AIDER_DESK_PORT` environment variable).
@@ -126,7 +133,9 @@ AiderDesk provides a REST API for external tools to interact with the applicatio
     }
   ]
   ```
+
   Returns the list of context files in the project.
+
 </details>
 
 #### Drop Context File
@@ -146,7 +155,9 @@ AiderDesk provides a REST API for external tools to interact with the applicatio
   ```json
   []
   ```
+
   Returns the list of context files in the project.
+
 </details>
 
 #### Get Context Files
@@ -170,7 +181,9 @@ AiderDesk provides a REST API for external tools to interact with the applicatio
     }
   ]
   ```
+
   Returns the list of context files in the project.
+
 </details>
 
 #### Get Addable Files
@@ -194,7 +207,9 @@ AiderDesk provides a REST API for external tools to interact with the applicatio
     }
   ]
   ```
+
   Returns the list of files that can be added to the project.
+
 </details>
 
 #### Run Prompt
@@ -234,9 +249,11 @@ AiderDesk provides a REST API for external tools to interact with the applicatio
     }
   ]
   ```
+
 </details>
 
 ---
+
 ### 🔌 AiderDesk as an MCP Server
 
 AiderDesk includes a built-in MCP server, allowing other MCP-compatible clients (like Claude Desktop, Cursor, etc.) to interact with AiderDesk's core functionalities.
@@ -263,6 +280,7 @@ Add the following configuration to your MCP client settings, adjusting paths as
 ```
 
 **Note:** Replace `path-to-appdata` with the absolute path to your AppData directory. You can find this value by running `echo %APPDATA%` in your command prompt.
+
 </details>
 
 <details>
@@ -283,6 +301,7 @@ Add the following configuration to your MCP client settings, adjusting paths as
 ```
 
 **Note:** Replace `/path/to/home` with the absolute path to your home directory. You can find this value by running `echo $HOME` in your terminal.
+
 </details>
 
 <details>
@@ -303,15 +322,18 @@ Add the following configuration to your MCP client settings, adjusting paths as
 ```
 
 **Note:** Replace `/path/to/home` with the absolute path to your home directory. You can find this value by running `echo $HOME` in your terminal.
+
 </details>
 
 **Arguments & Environment:**
+
 - **Command Argument 1:** Project directory path (required).
 - **`AIDER_DESK_API_BASE_URL`:** Base URL of the running AiderDesk API (default: `http://localhost:24337/api`).
 
 #### Available Tools via MCP
 
 The built-in server exposes these tools to MCP clients:
+
 - `add_context_file`: Add a file to AiderDesk's context.
 - `drop_context_file`: Remove a file from AiderDesk's context.
 - `get_context_files`: List files currently in AiderDesk's context.
@@ -325,36 +347,44 @@ The built-in server exposes these tools to MCP clients:
 ## 📥 Installation
 
 ### Quick Start
+
 1. Download the latest release for your OS from [Releases](https://github.com/hotovo/aider-desk/releases).
 2. Run the executable.
 
 ### Troubleshooting
 
 #### Disabling Auto Updates
+
 To prevent automatic updates, set the `AIDER_DESK_NO_AUTO_UPDATE` environment variable:
+
 - **macOS/Linux:** `export AIDER_DESK_NO_AUTO_UPDATE=true`
 - **Windows:** `$env:AIDER_DESK_NO_AUTO_UPDATE = "true"`
 
 ### Custom Aider Version
+
 By default, AiderDesk installs the latest version of the `aider-chat` Python package. If you need to use a specific version of Aider, you can set the `AIDER_DESK_AIDER_VERSION` environment variable.
 
 For example, to use Aider version 0.83.1:
+
 ```bash
 # macOS/Linux
 export AIDER_DESK_AIDER_VERSION=0.83.1
 
 # Windows (PowerShell)
 $env:AIDER_DESK_AIDER_VERSION = "0.83.1"
 ```
+
 You can also specify a git URL for installing a development version of Aider:
+
 ```bash
 # macOS/Linux
 export AIDER_DESK_AIDER_VERSION=git+https://github.com/user/aider.git@branch-name
 ```
 
-This variable will be used during the initial setup and when AiderDesk checks for updates. For more detailed information, please refer to [docs/custom-aider-version.md](https://github.com/hotovo/aider-desk/blob/main/docs/custom-aider-version.md).
+This variable will be used during the initial setup and when AiderDesk checks for updates. For more detailed information, please refer to [our docs](https://aiderdesk.hotovo.com/docs/customization/custom-aider-version).
 
 ## 👨‍💻 Development Setup
+
 If you want to run from source, you can follow these steps:
 
 ```bash
@@ -393,6 +423,7 @@ We welcome contributions from the community! Here's how you can help improve aid
 5. **Create a Pull Request** against the main branch of the original repository
 
 Please follow these guidelines:
+
 - Keep PRs focused on a single feature or bugfix
 - Update documentation when adding new features
 - Follow the existing code style and conventions

docs-site/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+node_modules
+
+# Production
+build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs-site/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/compact.md …s-site/docs/advanced-features/compact.mddocs/compact.md renamed to docs-site/docs/advanced-features/compact.md docs/compact.md renamed to docs-site/docs/advanced-features/compact.md

@@ -1,3 +1,9 @@
+---
+sidebar_position: 5
+title: "Compact Command"
+sidebar_label: "Compact"
+---
+
 # `/compact` Command
 
 The `/compact` command helps you summarize your conversation history with AiderDesk. This is particularly useful for long conversations, as it condenses the previous interactions into a concise summary, allowing the AI agent to maintain context more efficiently without being overwhelmed by excessive history.

docs/ide-integration.md …ocs/advanced-features/ide-integration.mddocs/ide-integration.md renamed to docs-site/docs/advanced-features/ide-integration.md docs/ide-integration.md renamed to docs-site/docs/advanced-features/ide-integration.md

@@ -1,3 +1,9 @@
+---
+sidebar_position: 3
+title: "IDE Integration"
+sidebar_label: "IDE Integration"
+---
+
 # IDE Integration
 
 AiderDesk is designed to work seamlessly with your favorite Integrated Development Environment (IDE). Through dedicated plugins and extensions, you can automatically sync the files you are working on with AiderDesk's context, creating a fluid and efficient workflow.
@@ -16,4 +22,4 @@ The VSCode extension automatically adds the currently active file in your editor
 - **Plugin**: [AiderDesk Connector on JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26313-aiderdesk-connector)
 - **Source Code**: [GitHub Repository](https://github.com/hotovo/aider-desk-connector-intellij-plugin)
 
-The IntelliJ plugin provides similar functionality, syncing the active editor file with AiderDesk's context. It is compatible with a wide range of JetBrains IDEs, including WebStorm, PyCharm, and GoLand.
+The IntelliJ plugin provides similar functionality, syncing the active editor file with AiderDesk's context. It is compatible with a wide range of JetBrains IDEs, including WebStorm, PyCharm, and GoLand.

docs/rest-api.md …-site/docs/advanced-features/rest-api.mddocs/rest-api.md renamed to docs-site/docs/advanced-features/rest-api.md docs/rest-api.md renamed to docs-site/docs/advanced-features/rest-api.md

@@ -1,3 +1,9 @@
+---
+sidebar_position: 4
+title: "REST API"
+sidebar_label: "REST API"
+---
+
 # REST API
 
 AiderDesk exposes a REST API that allows external tools, such as IDE plugins, to interact with the application programmatically. The API runs on the same port as the main application, which defaults to `24337` but can be configured with the `AIDER_DESK_PORT` environment variable.

docs/usage-tracking.md …docs/advanced-features/usage-tracking.mddocs/usage-tracking.md renamed to docs-site/docs/advanced-features/usage-tracking.md docs/usage-tracking.md renamed to docs-site/docs/advanced-features/usage-tracking.md

@@ -1,3 +1,9 @@
+---
+sidebar_position: 1
+title: "Usage and Cost Tracking"
+sidebar_label: "Usage Tracking"
+---
+
 # Usage and Cost Tracking
 
 AiderDesk provides detailed tools to help you monitor your token usage and associated costs, ensuring you stay in control of your spending.
@@ -28,4 +34,4 @@ For a more in-depth analysis, AiderDesk includes a comprehensive Usage Dashboard
     - **Token Usage Trend**: A line chart showing input, output, and total token usage over time.
     - **Model Usage Distribution**: A pie chart showing the percentage of tokens used by each model.
     - **Daily Cost Breakdown**: A stacked bar chart showing daily costs, broken down by project.
-    - **Daily Message Breakdown**: A stacked bar chart showing the number of messages per day, broken down by project.
+    - **Daily Message Breakdown**: A stacked bar chart showing the number of messages per day, broken down by project.