versionhq 1.1.12.3__tar.gz → 1.1.12.5__tar.gz

versionhq-1.1.12.5/.github/workflows/deploy_docs.yml

@@ -0,0 +1,30 @@
+name: Deploy Docs
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - run: echo "cache_id=$(date +%s)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force

{versionhq-1.1.12.3 → versionhq-1.1.12.5}/.gitignore

@@ -5,8 +5,8 @@ entity_memory.py
 
 train.py
 
-mkdocs.yml
-docs/
+# mkdocs.yml
+# docs/
 
 dist/
 lib/
@@ -23,6 +23,7 @@ temp/*
 .vscode/*
 assets/*
 memo.txt
+site/
 
 __pycache__
 .ruff_cache/

{versionhq-1.1.12.3 → versionhq-1.1.12.5}/.pre-commit-config.yaml

@@ -41,3 +41,4 @@ repos:
   rev: v2.2.0
   hooks:
     - id: doctoc
+      files: README.md

versionhq-1.1.12.5/CNAME

@@ -0,0 +1 @@
+docs.versi0n.io

{versionhq-1.1.12.3 → versionhq-1.1.12.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.2
 Name: versionhq
-Version: 1.1.12.3
-Summary: An agentic orchestration framework for multi-agent system that shares memory, knowledge base, and RAG tools.
+Version: 1.1.12.5
+Summary: An agentic orchestration framework for building agent networks that handle task automation without human interaction.
 Author-email: Kuriko Iwai <kuriko@versi0n.io>
 License: MIT License
         
@@ -26,7 +26,7 @@ License: MIT License
         SOFTWARE.
         
 Project-URL: Homepage, https://versi0n.io
-Project-URL: Documentation, https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=73
+Project-URL: Documentation, https://docs.versi0n.io
 Project-URL: Repository, https://github.com/versionHQ/multi-agent-system
 Project-URL: Issues, https://github.com/versionHQ/multi-agent-system/issues
 Keywords: orchestration framework,orchestration,ai agent,multi-agent system,RAG,agent,agentic orchestration,llm
@@ -77,6 +77,7 @@ Requires-Dist: numpy>=1.26.4; extra == "numpy"
 
 # Overview
 
+![DL](https://img.shields.io/badge/Download-15K+-red)
 ![MIT license](https://img.shields.io/badge/License-MIT-green)
 [![Publisher](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml/badge.svg)](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml)
 ![PyPI](https://img.shields.io/badge/PyPI-v1.1.12+-blue)
@@ -89,9 +90,9 @@ Agentic orchestration framework to deploy agent network and handle complex task
 **Visit:**
 
 - [PyPI](https://pypi.org/project/versionhq/)
-- [Github (LLM orchestration framework)](https://github.com/versionHQ/multi-agent-system)
-- [Use case](https://versi0n.io/) / [Quick demo](https://res.cloudinary.com/dfeirxlea/video/upload/v1737732977/pj_m_home/pnsyh5mfvmilwgt0eusa.mov)
-- [Documentation](https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=4) *Some components are under review.
+- [Docs](https://docs.versi0n.io)
+- [Github Repository](https://github.com/versionHQ/multi-agent-system)
+- [Playground](https://versi0n.io/)
 
 
 <hr />
@@ -105,13 +106,14 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [Quick Start](#quick-start)
   - [Generate agent networks and launch task execution:](#generate-agent-networks-and-launch-task-execution)
   - [Solo Agent:](#solo-agent)
-    - [Return a structured output with a summary in string.](#return-a-structured-output-with-a-summary-in-string)
+  - [Solo Agent:](#solo-agent-1)
   - [Supervising:](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
 - [Contributing](#contributing)
-  - [Customizing AI Agents](#customizing-ai-agents)
+  - [Documentation](#documentation)
+  - [Customizing AI Agent](#customizing-ai-agent)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
   - [Pre-Commit Hooks](#pre-commit-hooks)
@@ -124,7 +126,7 @@ Agentic orchestration framework to deploy agent network and handle complex task
 
 ## Key Features
 
-`versionhq` is a Python framework that can generate agent networks for complex task automation without human interaction.
+`versionhq` is a Python framework for agent networks that handle complex task automation without human interaction.
 
 Agents are model-agnostic, and will improve task output, while oprimizing token cost and job latency, by sharing their memory, knowledge base, and RAG tools with other agents in the network.
 
@@ -138,7 +140,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 |  | **Solo Agent** | **Supervising** | **Network** | **Random** |
 | :--- | :--- | :--- | :--- | :--- |
-| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893140/pj_m_agents/tglrxoiuv7kk7nzvpe1z.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893141/pj_m_agents/hxngdvnn5b5qdxo0ayl5.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893142/pj_m_agents/kyc6neg8m6keyizszcpi.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893139/pj_m_agents/hzpchlcpnpwxwaapu1hr.jpg" alt="solo" width="200"> |
+| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/rbgxttfoeqqis1ettlfz.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/zhungor3elxzer5dum10.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/dnusl7iy7kiwkxwlpmg8.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/sndpczatfzbrosxz9ama.png" alt="solo" width="200"> |
 | **Usage** | <ul><li>A single agent with tools, knowledge, and memory.</li><li>When self-learning mode is on - it will turn into **Random** formation.</li></ul> | <ul><li>Leader agent gives directions, while sharing its knowledge and memory.</li><li>Subordinates can be solo agents or networks.</li></ul> | <ul><li>Share tasks, knowledge, and memory among network members.</li></ul> | <ul><li>A single agent handles tasks, asking help from other agents without sharing its memory or knowledge.</li></ul> |
 | **Use case** | An email agent drafts promo message for the given audience. | The leader agent strategizes an outbound campaign plan and assigns components such as media mix or message creation to subordinate agents. | An email agent and social media agent share the product knowledge and deploy multi-channel outbound campaign. | 1. An email agent drafts promo message for the given audience, asking insights on tones from other email agents which oversee other clusters. 2. An agent calls the external agent to deploy the campaign. |
 
@@ -156,7 +158,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 ### Generate agent networks and launch task execution:
 
-   ```
+   ```python
    from versionhq import form_agent_network
 
    network = form_agent_network(
@@ -171,9 +173,15 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 ### Solo Agent:
 
-#### Return a structured output with a summary in string.
+### Solo Agent:
 
-   ```
+You can simply build an agent using `Agent` model.
+
+By default, the agent prioritize JSON serializable output.
+
+But you can add a plane text summary of the structured output by using callbacks.
+
+   ```python
    from pydantic import BaseModel
    from versionhq import Agent, Task
 
@@ -198,23 +206,24 @@ You can specify a desired formation or allow the agents to determine it autonomo
    print(res)
    ```
 
-This will return `TaskOutput` instance that stores a response in plane text, JSON serializable dict, and Pydantic model: `CustomOutput` formats with a callback result, tool output (if given), and evaluation results (if given).
 
-   ```
+This will return a `TaskOutput` object that stores response in plane text, JSON, and Pydantic model: `CustomOutput` formats with a callback result, tool output (if given), and evaluation results (if given).
+
+   ```python
    res == TaskOutput(
-      task_id=UUID('<TASK UUID>')
+      task_id=UUID('<TASK UUID>'),
       raw='{\"test1\":\"random str\", \"test2\":[\"str item 1\", \"str item 2\", \"str item 3\"]}',
       json_dict={'test1': 'random str', 'test2': ['str item 1', 'str item 2', 'str item 3']},
-      pydantic=<class '__main__.CustomOutput'>
+      pydantic=<class '__main__.CustomOutput'>,
       tool_output=None,
-      callback_output='Hi! Here is the result: random str, str item 1, str item 2, str item 3',
+      callback_output='Hi! Here is the result: random str, str item 1, str item 2, str item 3', # returned a plain text summary
       evaluation=None
    )
    ```
 
 ### Supervising:
 
-   ```
+   ```python
    from versionhq import Agent, Task, ResponseField, Team, TeamMember
 
    agent_a = Agent(role="agent a", goal="My amazing goals", llm="llm-of-your-choice")
@@ -279,26 +288,22 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 .github
 └── workflows/                # Github actions
 │
+docs/                         # Documentation built by MkDocs
+│
 src/
-└── versionhq/                # Orchestration frameworks
-│     ├── agent/              # Components
+└── versionhq/                # Orchestration framework package
+│     ├── agent/              # Core components
 │     └── llm/
 │     └── task/
-│     └── team/
 │     └── tool/
-│     └── cli/
-│     └── ...
-│     │
-│     ├── db/                 # Storage
-│     ├── chroma.sqlite3
 │     └── ...
 │
-└──tests/                     # Pytest
+└──tests/                     # Pytest - by core component and use cases in the docs
 │     └── agent/
 │     └── llm/
 │     └── ...
 │
-└── uploads/                  # Local repo to store the uploaded files
+└── uploads/                  # Local directory that stores uloaded files
 
 ```
 
@@ -308,17 +313,18 @@ src/
 
 1. Install `uv` package manager:
 
-   For MacOS:
+      For MacOS:
 
-   ```
-   brew install uv
-   ```
+      ```
+      brew install uv
+      ```
 
-   For Ubuntu/Debian:
+      For Ubuntu/Debian:
+
+      ```
+      sudo apt-get install uv
+      ```
 
-   ```
-   sudo apt-get install uv
-   ```
 
 2. Install dependencies:
    ```
@@ -340,11 +346,11 @@ src/
 3. Set up environment variables:
    Create a `.env` file in the project root and add the following:
    ```
-   OPENAI_API_KEY=your-openai-api-key
    LITELLM_API_KEY=your-litellm-api-key
-   UPSTAGE_API_KEY=your-upstage-api-key
+   OPENAI_API_KEY=your-openai-api-key
    COMPOSIO_API_KEY=your-composio-api-key
    COMPOSIO_CLI_KEY=your-composio-cli-key
+   [LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
@@ -378,18 +384,30 @@ src/
 **Optional**
 * Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
 
-* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+<!-- * Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
    ```
    npm i
    npm start
    ```
-   The frontend will be available at `http://localhost:3000`.
+   The frontend will be available at `http://localhost:3000`. -->
 
 * `production` use case is available at `https://versi0n.io`. Currently, we are running alpha test.
 
 
+### Documentation
+
+* To edit the documentation, see `docs` repository and edit the respective component.
+
+* We use `mkdocs` to update the docs. You can run the doc locally at http://127.0.0.1:8000/:
+
+   ```
+   uv run python3 -m mkdocs serve --clean
+   ```
+
+* To add a new page, update `mkdocs.yml` in the root. Refer to [MkDocs official docs](https://squidfunk.github.io/mkdocs-material/getting-started/) for more details.
 
-### Customizing AI Agents
+
+### Customizing AI Agent
 
 To add an agent, use `sample` directory to add new `project`. You can define an agent with a specific role, goal, and set of tools.
 
@@ -454,27 +472,10 @@ Common issues and solutions:
 ## Frequently Asked Questions (FAQ)
 **Q. Where can I see if the agent is working?**
 
-> A. You can find a frontend app [here](https://versi0n.io) with real-world outbound use cases.
-> You can also test features [here](https://github.com/versionHQ/test-client-app) using React app.
+A. Visit [playground](https://versi0n.io).
+
 
 **Q. How do you analyze the customer?**
 
 > A. We employ soft clustering for each customer.
 > <img width="200" src="https://res.cloudinary.com/dfeirxlea/image/upload/v1732732628/pj_m_agents/ito937s5d5x0so8isvw6.png">
-
-
-**Q. When should I use a team vs an agent?**
-
-> A. In essence, use a team for intricate, evolving projects, and agents for quick, straightforward tasks.
-
-> Use a team when:
-
-> **Complex tasks**: You need to complete multiple, interconnected tasks that require sequential or hierarchical processing.
-
-> **Iterative refinement**: You want to iteratively improve upon the output through multiple rounds of feedback and revision.
-
-> Use an agent when:
-
-> **Simple tasks**: You have a straightforward, one-off task that doesn't require significant complexity or iteration.
-
-> **Human input**: You need to provide initial input or guidance to the agent, or you expect to review and refine the output.

{versionhq-1.1.12.3 → versionhq-1.1.12.5}/README.md

@@ -1,5 +1,6 @@
 # Overview
 
+![DL](https://img.shields.io/badge/Download-15K+-red)
 ![MIT license](https://img.shields.io/badge/License-MIT-green)
 [![Publisher](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml/badge.svg)](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml)
 ![PyPI](https://img.shields.io/badge/PyPI-v1.1.12+-blue)
@@ -12,9 +13,9 @@ Agentic orchestration framework to deploy agent network and handle complex task
 **Visit:**
 
 - [PyPI](https://pypi.org/project/versionhq/)
-- [Github (LLM orchestration framework)](https://github.com/versionHQ/multi-agent-system)
-- [Use case](https://versi0n.io/) / [Quick demo](https://res.cloudinary.com/dfeirxlea/video/upload/v1737732977/pj_m_home/pnsyh5mfvmilwgt0eusa.mov)
-- [Documentation](https://chief-oxygen-8a2.notion.site/Documentation-17e923685cf98001a5fad5c4b2acd79b?pvs=4) *Some components are under review.
+- [Docs](https://docs.versi0n.io)
+- [Github Repository](https://github.com/versionHQ/multi-agent-system)
+- [Playground](https://versi0n.io/)
 
 
 <hr />
@@ -28,13 +29,14 @@ Agentic orchestration framework to deploy agent network and handle complex task
 - [Quick Start](#quick-start)
   - [Generate agent networks and launch task execution:](#generate-agent-networks-and-launch-task-execution)
   - [Solo Agent:](#solo-agent)
-    - [Return a structured output with a summary in string.](#return-a-structured-output-with-a-summary-in-string)
+  - [Solo Agent:](#solo-agent-1)
   - [Supervising:](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
 - [Contributing](#contributing)
-  - [Customizing AI Agents](#customizing-ai-agents)
+  - [Documentation](#documentation)
+  - [Customizing AI Agent](#customizing-ai-agent)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
   - [Pre-Commit Hooks](#pre-commit-hooks)
@@ -47,7 +49,7 @@ Agentic orchestration framework to deploy agent network and handle complex task
 
 ## Key Features
 
-`versionhq` is a Python framework that can generate agent networks for complex task automation without human interaction.
+`versionhq` is a Python framework for agent networks that handle complex task automation without human interaction.
 
 Agents are model-agnostic, and will improve task output, while oprimizing token cost and job latency, by sharing their memory, knowledge base, and RAG tools with other agents in the network.
 
@@ -61,7 +63,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 |  | **Solo Agent** | **Supervising** | **Network** | **Random** |
 | :--- | :--- | :--- | :--- | :--- |
-| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893140/pj_m_agents/tglrxoiuv7kk7nzvpe1z.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893141/pj_m_agents/hxngdvnn5b5qdxo0ayl5.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893142/pj_m_agents/kyc6neg8m6keyizszcpi.jpg" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1737893139/pj_m_agents/hzpchlcpnpwxwaapu1hr.jpg" alt="solo" width="200"> |
+| **Formation** | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/rbgxttfoeqqis1ettlfz.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/zhungor3elxzer5dum10.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/dnusl7iy7kiwkxwlpmg8.png" alt="solo" width="200"> | <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1738818211/pj_m_agents/sndpczatfzbrosxz9ama.png" alt="solo" width="200"> |
 | **Usage** | <ul><li>A single agent with tools, knowledge, and memory.</li><li>When self-learning mode is on - it will turn into **Random** formation.</li></ul> | <ul><li>Leader agent gives directions, while sharing its knowledge and memory.</li><li>Subordinates can be solo agents or networks.</li></ul> | <ul><li>Share tasks, knowledge, and memory among network members.</li></ul> | <ul><li>A single agent handles tasks, asking help from other agents without sharing its memory or knowledge.</li></ul> |
 | **Use case** | An email agent drafts promo message for the given audience. | The leader agent strategizes an outbound campaign plan and assigns components such as media mix or message creation to subordinate agents. | An email agent and social media agent share the product knowledge and deploy multi-channel outbound campaign. | 1. An email agent drafts promo message for the given audience, asking insights on tones from other email agents which oversee other clusters. 2. An agent calls the external agent to deploy the campaign. |
 
@@ -79,7 +81,7 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 ### Generate agent networks and launch task execution:
 
-   ```
+   ```python
    from versionhq import form_agent_network
 
    network = form_agent_network(
@@ -94,9 +96,15 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 ### Solo Agent:
 
-#### Return a structured output with a summary in string.
+### Solo Agent:
 
-   ```
+You can simply build an agent using `Agent` model.
+
+By default, the agent prioritize JSON serializable output.
+
+But you can add a plane text summary of the structured output by using callbacks.
+
+   ```python
    from pydantic import BaseModel
    from versionhq import Agent, Task
 
@@ -121,23 +129,24 @@ You can specify a desired formation or allow the agents to determine it autonomo
    print(res)
    ```
 
-This will return `TaskOutput` instance that stores a response in plane text, JSON serializable dict, and Pydantic model: `CustomOutput` formats with a callback result, tool output (if given), and evaluation results (if given).
 
-   ```
+This will return a `TaskOutput` object that stores response in plane text, JSON, and Pydantic model: `CustomOutput` formats with a callback result, tool output (if given), and evaluation results (if given).
+
+   ```python
    res == TaskOutput(
-      task_id=UUID('<TASK UUID>')
+      task_id=UUID('<TASK UUID>'),
       raw='{\"test1\":\"random str\", \"test2\":[\"str item 1\", \"str item 2\", \"str item 3\"]}',
       json_dict={'test1': 'random str', 'test2': ['str item 1', 'str item 2', 'str item 3']},
-      pydantic=<class '__main__.CustomOutput'>
+      pydantic=<class '__main__.CustomOutput'>,
       tool_output=None,
-      callback_output='Hi! Here is the result: random str, str item 1, str item 2, str item 3',
+      callback_output='Hi! Here is the result: random str, str item 1, str item 2, str item 3', # returned a plain text summary
       evaluation=None
    )
    ```
 
 ### Supervising:
 
-   ```
+   ```python
    from versionhq import Agent, Task, ResponseField, Team, TeamMember
 
    agent_a = Agent(role="agent a", goal="My amazing goals", llm="llm-of-your-choice")
@@ -202,26 +211,22 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 .github
 └── workflows/                # Github actions
 │
+docs/                         # Documentation built by MkDocs
+│
 src/
-└── versionhq/                # Orchestration frameworks
-│     ├── agent/              # Components
+└── versionhq/                # Orchestration framework package
+│     ├── agent/              # Core components
 │     └── llm/
 │     └── task/
-│     └── team/
 │     └── tool/
-│     └── cli/
-│     └── ...
-│     │
-│     ├── db/                 # Storage
-│     ├── chroma.sqlite3
 │     └── ...
 │
-└──tests/                     # Pytest
+└──tests/                     # Pytest - by core component and use cases in the docs
 │     └── agent/
 │     └── llm/
 │     └── ...
 │
-└── uploads/                  # Local repo to store the uploaded files
+└── uploads/                  # Local directory that stores uloaded files
 
 ```
 
@@ -231,17 +236,18 @@ src/
 
 1. Install `uv` package manager:
 
-   For MacOS:
+      For MacOS:
 
-   ```
-   brew install uv
-   ```
+      ```
+      brew install uv
+      ```
 
-   For Ubuntu/Debian:
+      For Ubuntu/Debian:
+
+      ```
+      sudo apt-get install uv
+      ```
 
-   ```
-   sudo apt-get install uv
-   ```
 
 2. Install dependencies:
    ```
@@ -263,11 +269,11 @@ src/
 3. Set up environment variables:
    Create a `.env` file in the project root and add the following:
    ```
-   OPENAI_API_KEY=your-openai-api-key
    LITELLM_API_KEY=your-litellm-api-key
-   UPSTAGE_API_KEY=your-upstage-api-key
+   OPENAI_API_KEY=your-openai-api-key
    COMPOSIO_API_KEY=your-composio-api-key
    COMPOSIO_CLI_KEY=your-composio-cli-key
+   [LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
@@ -301,18 +307,30 @@ src/
 **Optional**
 * Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
 
-* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+<!-- * Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
    ```
    npm i
    npm start
    ```
-   The frontend will be available at `http://localhost:3000`.
+   The frontend will be available at `http://localhost:3000`. -->
 
 * `production` use case is available at `https://versi0n.io`. Currently, we are running alpha test.
 
 
+### Documentation
+
+* To edit the documentation, see `docs` repository and edit the respective component.
+
+* We use `mkdocs` to update the docs. You can run the doc locally at http://127.0.0.1:8000/:
+
+   ```
+   uv run python3 -m mkdocs serve --clean
+   ```
+
+* To add a new page, update `mkdocs.yml` in the root. Refer to [MkDocs official docs](https://squidfunk.github.io/mkdocs-material/getting-started/) for more details.
 
-### Customizing AI Agents
+
+### Customizing AI Agent
 
 To add an agent, use `sample` directory to add new `project`. You can define an agent with a specific role, goal, and set of tools.
 
@@ -377,27 +395,10 @@ Common issues and solutions:
 ## Frequently Asked Questions (FAQ)
 **Q. Where can I see if the agent is working?**
 
-> A. You can find a frontend app [here](https://versi0n.io) with real-world outbound use cases.
-> You can also test features [here](https://github.com/versionHQ/test-client-app) using React app.
+A. Visit [playground](https://versi0n.io).
+
 
 **Q. How do you analyze the customer?**
 
 > A. We employ soft clustering for each customer.
 > <img width="200" src="https://res.cloudinary.com/dfeirxlea/image/upload/v1732732628/pj_m_agents/ito937s5d5x0so8isvw6.png">
-
-
-**Q. When should I use a team vs an agent?**
-
-> A. In essence, use a team for intricate, evolving projects, and agents for quick, straightforward tasks.
-
-> Use a team when:
-
-> **Complex tasks**: You need to complete multiple, interconnected tasks that require sequential or hierarchical processing.
-
-> **Iterative refinement**: You want to iteratively improve upon the output through multiple rounds of feedback and revision.
-
-> Use an agent when:
-
-> **Simple tasks**: You have a straightforward, one-off task that doesn't require significant complexity or iteration.
-
-> **Human input**: You need to provide initial input or guidance to the agent, or you expect to review and refine the output.

versionhq-1.1.12.5/docs/CNAME

@@ -0,0 +1 @@
+docs.versi0n.io