versionhq 1.1.13.0__tar.gz → 1.2.0.1__tar.gz

{versionhq-1.1.13.0 → versionhq-1.2.0.1}/.github/workflows/run_tests.yml

@@ -37,7 +37,7 @@ jobs:
           uv venv --python 3.12.8
           source .venv/bin/activate
           uv lock --upgrade
-          uv sync --all-extras
+          uv sync --all-extras --no-extra pygraphviz
 
       - name: Run tests
         run: uv run pytest tests -vv --cache-clear

{versionhq-1.1.13.0 → versionhq-1.2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: versionhq
-Version: 1.1.13.0
+Version: 1.2.0.1
 Summary: An agentic orchestration framework for building agent networks that handle task automation.
 Author-email: Kuriko Iwai <kuriko@versi0n.io>
 License: MIT License
@@ -74,13 +74,19 @@ Provides-Extra: pandas
 Requires-Dist: pandas>=2.2.3; extra == "pandas"
 Provides-Extra: numpy
 Requires-Dist: numpy>=1.26.4; extra == "numpy"
+Provides-Extra: pygraphviz
+Requires-Dist: pygraphviz>=1.14; extra == "pygraphviz"
+Provides-Extra: networkx
+Requires-Dist: networkx>=3.4.2; extra == "networkx"
+Provides-Extra: matplotlib
+Requires-Dist: matplotlib>=3.10.0; extra == "matplotlib"
 
 # Overview
 
 [![DL](https://img.shields.io/badge/Download-15K+-red)](https://clickpy.clickhouse.com/dashboard/versionhq)
 ![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)
+![PyPI](https://img.shields.io/badge/PyPI-v1.2.0+-blue)
 ![python ver](https://img.shields.io/badge/Python-3.11+-purple)
 ![pyenv ver](https://img.shields.io/badge/pyenv-2.5.0-orange)
 
@@ -103,15 +109,21 @@ A Python framework for agentic orchestration that handles complex task automatio
 
 - [Key Features](#key-features)
   - [Agent formation](#agent-formation)
+  - [Graph Theory Concept](#graph-theory-concept)
+  - [Agent optimization](#agent-optimization)
 - [Quick Start](#quick-start)
   - [Package installation](#package-installation)
   - [Forming a agent network](#forming-a-agent-network)
-  - [Customizing AI agents](#customizing-ai-agents)
+  - [Executing tasks](#executing-tasks)
   - [Supervising](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
-- [Setting Up](#setting-up)
+- [Setting Up a Project](#setting-up-a-project)
+  - [1. Installing package manager](#1-installing-package-manager)
+  - [2. Installing dependencies](#2-installing-dependencies)
+  - [3. Adding env secrets to .env file](#3-adding-env-secrets-to-env-file)
 - [Contributing](#contributing)
+  - [Steps](#steps)
   - [Package Management with uv](#package-management-with-uv)
   - [Pre-Commit Hooks](#pre-commit-hooks)
   - [Documentation](#documentation)
@@ -144,6 +156,73 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 <hr />
 
+### Graph Theory Concept
+
+To completely automate task workflows, agents will build a `task-oriented network` by generating `nodes` that represent tasks and connecting them with dependency-defining `edges`.
+
+Each node is triggered by specific events and executed by an assigned agent once all dependencies are met.
+
+While the network automatically reconfigures itself, you retain the ability to direct the agents using `should_reform` variable.
+
+
+The following code snippet demonstrates the `TaskGraph` and its visualization, saving the diagram to the `uploads` directory.
+
+```python
+import versionhq as vhq
+
+task_graph = vhq.TaskGraph(directed=False, should_reform=True) # triggering auto formation
+
+task_a = vhq.Task(description="Research Topic")
+task_b = vhq.Task(description="Outline Post")
+task_c = vhq.Task(description="Write First Draft")
+
+node_a = task_graph.add_task(task=task_a)
+node_b = task_graph.add_task(task=task_b)
+node_c = task_graph.add_task(task=task_c)
+
+task_graph.add_dependency(
+   node_a.identifier, node_b.identifier,
+   type=vhq.DependencyType.FINISH_TO_START, weight=5, description="B depends on A"
+)
+task_graph.add_dependency(
+   node_a.identifier, node_c.identifier,
+   type=vhq.DependencyType.FINISH_TO_FINISH, lag=1, required=False, weight=3
+)
+
+task_graph.visualize()
+```
+
+<hr />
+
+### Agent optimization
+
+Agents are model-agnostic and can handle multiple tasks, leveraging their own and their peers' knowledge sources, memories, and tools.
+
+Agents are optimized during network formation, but customization is possible before or after.
+
+The following code snippet demonstrates agent customization:
+
+```python
+import versionhq as vhq
+
+agent = vhq.Agent(
+   role="Marketing Analyst",
+   goal="my amazing goal"
+) # assuming this agent was created during the network formation
+
+# update the agent
+agent.update(
+   llm="gemini-2.0", # updating LLM (Valid llm_config will be inherited to the new LLM.)
+   tools=[vhq.Tool(func=lambda x: x)], # adding tools
+   max_rpm=3,
+   knowledge_sources=["<KC1>", "<KS2>"], # adding knowledge sources. This will trigger the storage creation.
+   memory_config={"user_id": "0001"}, # adding memories
+   dummy="I am dummy" # <- invalid field will be automatically ignored
+)
+```
+
+<hr />
+
 ## Quick Start
 
 ### Package installation
@@ -169,11 +248,11 @@ You can specify a desired formation or allow the agents to determine it autonomo
    This will form a network with multiple agents on `Formation` and return `TaskOutput` object with output in JSON, plane text, Pydantic model format with evaluation.
 
 
-### Customizing AI agents
+### Executing tasks
 
-You can simply build an agent using `Agent` model.
+You can simply build an agent using `Agent` model and execute the task using `Task` class.
 
-By default, the agent prioritize JSON serializable outputs over plane texts.
+By default, agents prioritize JSON over plane text outputs.
 
 
    ```python
@@ -189,7 +268,6 @@ By default, the agent prioritize JSON serializable outputs over plane texts.
 
 
    agent = vhq.Agent(role="demo", goal="amazing project goal")
-
    task = vhq.Task(
       description="Amazing task",
       pydantic_output=CustomOutput,
@@ -197,7 +275,7 @@ By default, the agent prioritize JSON serializable outputs over plane texts.
       callback_kwargs=dict(message="Hi! Here is the result: ")
    )
 
-   res = task.execute_sync(agent=agent, context="amazing context to consider.")
+   res = task.execute(agent=agent, context="amazing context to consider.")
    print(res)
    ```
 
@@ -253,21 +331,29 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 
 ## Technologies Used
 
+**Graph Theory (Analysis and Visualization)**
+
+* [NetworkX](https://networkx.org/documentation/stable/reference/introduction.html): A Python package to analyze, create, and manipulate complex graph networks.
+* [Matplotlib](https://matplotlib.org/stable/index.html): Visualization library
+* [Graphviz](https://graphviz.org/about/): Graph visualization software
+
+
 **Schema, Data Validation**
 
 * [Pydantic](https://docs.pydantic.dev/latest/): Data validation and serialization library for Python.
 * [Upstage](https://console.upstage.ai/docs/getting-started/overview): Document processer for ML tasks. (Use `Document Parser API` to extract data from documents)
 * [Docling](https://ds4sd.github.io/docling/): Document parsing
 
+
 **Storage**
 
 * [mem0ai](https://docs.mem0.ai/quickstart#install-package): Agents' memory storage and management.
 * [Chroma DB](https://docs.trychroma.com/): Vector database for storing and querying usage data.
 * [SQLite](https://www.sqlite.org/docs.html): C-language library to implements a small SQL database engine.
 
-**LLM-curation**
+**LLM Integration**
 
-* [LiteLLM](https://docs.litellm.ai/docs/providers): Curation platform to access LLMs
+* [LiteLLM](https://docs.litellm.ai/docs/providers): Integration to diverse LLMs
 
 **Tools**
 
@@ -290,6 +376,7 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 └── workflows/                # Github actions
 │
 docs/                         # Documentation built by MkDocs
+mkdocs.yml                    # MkDocs config
 │
 src/
 └── versionhq/                # Orchestration framework package
@@ -304,30 +391,32 @@ src/
 │     └── llm/
 │     └── ...
 │
-└── uploads/                  # Local directory that stores uloaded files
+└── uploads/  [.gitignore]    # Local directory to store uploaded files such as graphviz diagrams generatd by `Network` class
+|
+pyproject.toml                # Project config
 
 ```
 
 <hr />
 
-## Setting Up
+## Setting Up a Project
 
-1. Install `uv` package manager:
+### 1. Installing 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. Installing dependencies
 
-2. Install dependencies:
    ```
    uv venv
    source .venv/bin/activate
@@ -335,29 +424,51 @@ src/
    uv sync --all-extras
    ```
 
-* In case of AssertionError/module mismatch, run Python version control using `.pyenv`
-   ```
-   pyenv install 3.12.8
-   pyenv global 3.12.8  (optional: `pyenv global system` to get back to the system default ver.)
-   uv python pin 3.12.8
-   echo 3.12.8 >> .python-version
-   ```
+   - AssertionError/module mismatch errors: Set up default Python version using `.pyenv`
+      ```
+      pyenv install 3.12.8
+      pyenv global 3.12.8  (optional: `pyenv global system` to get back to the system default ver.)
+      uv python pin 3.12.8
+      echo 3.12.8 >> .python-version
+      ```
 
+   - `pygraphviz` related errors: Run the following commands:
+      ```
+      brew install graphviz
+      uv pip install --config-settings="--global-option=build_ext" \
+      --config-settings="--global-option=-I$(brew --prefix graphviz)/include/" \
+      --config-settings="--global-option=-L$(brew --prefix graphviz)/lib/" \
+      pygraphviz
+      ```
+
+      * If the error continues, skip pygraphviz installation by:
+      ```
+      uv sync --all-extras --no-extra pygraphviz
+      ```
+
+   - `torch`/`Docling` related errors: Set up default Python version either `3.11.x` or `3.12.x` (same as AssertionError)
+
+### 3. Adding env secrets to .env file
 
-3. Add secrets to `.env` file in the project root:
+Create `.env` file in the project root and add following:
 
    ```
-   LITELLM_API_KEY=your-litellm-api-key
    OPENAI_API_KEY=your-openai-api-key
+   GEMINI_API_KEY=your-gemini-api-key
+   LITELLM_API_KEY=your-litellm-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
+   [OTHER_LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
 
 ## Contributing
 
+`versionhq` is a open source project.
+
+### Steps
+
 1. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
 
 2. Create amazing features
@@ -365,6 +476,7 @@ src/
 3. Add a test funcition to the `tests` directory and run **pytest**.
 
    - Add secret values defined in `.github/workflows/run_test.yml` to your Github `repository secrets` located at settings > secrets & variables > Actions.
+
    - Run a following command:
       ```
       uv run pytest tests -vv --cache-clear
@@ -376,6 +488,8 @@ src/
 
    * Test functions within the files must begin with `test_`.
 
+   * Pytest priorities are `1. playground demo > 2. docs use cases > 3. other features`
+
 
 4. Update `docs` accordingly.
 
@@ -418,7 +532,7 @@ src/
 
 Pre-commit hooks help maintain code quality by running checks for formatting, linting, and other issues before each commit.
 
-* To skip pre-commit hooks (NOT RECOMMENDED)
+* To skip pre-commit hooks
    ```
    git commit --no-verify -m "your-commit-message"
    ```
@@ -427,7 +541,7 @@ Pre-commit hooks help maintain code quality by running checks for formatting, li
 
 * 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/:
+* We use `mkdocs` to update the docs. You can run the docs locally at http://127.0.0.1:8000/.
 
    ```
    uv run python3 -m mkdocs serve --clean

{versionhq-1.1.13.0 → versionhq-1.2.0.1}/README.md

@@ -3,7 +3,7 @@
 [![DL](https://img.shields.io/badge/Download-15K+-red)](https://clickpy.clickhouse.com/dashboard/versionhq)
 ![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)
+![PyPI](https://img.shields.io/badge/PyPI-v1.2.0+-blue)
 ![python ver](https://img.shields.io/badge/Python-3.11+-purple)
 ![pyenv ver](https://img.shields.io/badge/pyenv-2.5.0-orange)
 
@@ -26,15 +26,21 @@ A Python framework for agentic orchestration that handles complex task automatio
 
 - [Key Features](#key-features)
   - [Agent formation](#agent-formation)
+  - [Graph Theory Concept](#graph-theory-concept)
+  - [Agent optimization](#agent-optimization)
 - [Quick Start](#quick-start)
   - [Package installation](#package-installation)
   - [Forming a agent network](#forming-a-agent-network)
-  - [Customizing AI agents](#customizing-ai-agents)
+  - [Executing tasks](#executing-tasks)
   - [Supervising](#supervising)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
-- [Setting Up](#setting-up)
+- [Setting Up a Project](#setting-up-a-project)
+  - [1. Installing package manager](#1-installing-package-manager)
+  - [2. Installing dependencies](#2-installing-dependencies)
+  - [3. Adding env secrets to .env file](#3-adding-env-secrets-to-env-file)
 - [Contributing](#contributing)
+  - [Steps](#steps)
   - [Package Management with uv](#package-management-with-uv)
   - [Pre-Commit Hooks](#pre-commit-hooks)
   - [Documentation](#documentation)
@@ -67,6 +73,73 @@ You can specify a desired formation or allow the agents to determine it autonomo
 
 <hr />
 
+### Graph Theory Concept
+
+To completely automate task workflows, agents will build a `task-oriented network` by generating `nodes` that represent tasks and connecting them with dependency-defining `edges`.
+
+Each node is triggered by specific events and executed by an assigned agent once all dependencies are met.
+
+While the network automatically reconfigures itself, you retain the ability to direct the agents using `should_reform` variable.
+
+
+The following code snippet demonstrates the `TaskGraph` and its visualization, saving the diagram to the `uploads` directory.
+
+```python
+import versionhq as vhq
+
+task_graph = vhq.TaskGraph(directed=False, should_reform=True) # triggering auto formation
+
+task_a = vhq.Task(description="Research Topic")
+task_b = vhq.Task(description="Outline Post")
+task_c = vhq.Task(description="Write First Draft")
+
+node_a = task_graph.add_task(task=task_a)
+node_b = task_graph.add_task(task=task_b)
+node_c = task_graph.add_task(task=task_c)
+
+task_graph.add_dependency(
+   node_a.identifier, node_b.identifier,
+   type=vhq.DependencyType.FINISH_TO_START, weight=5, description="B depends on A"
+)
+task_graph.add_dependency(
+   node_a.identifier, node_c.identifier,
+   type=vhq.DependencyType.FINISH_TO_FINISH, lag=1, required=False, weight=3
+)
+
+task_graph.visualize()
+```
+
+<hr />
+
+### Agent optimization
+
+Agents are model-agnostic and can handle multiple tasks, leveraging their own and their peers' knowledge sources, memories, and tools.
+
+Agents are optimized during network formation, but customization is possible before or after.
+
+The following code snippet demonstrates agent customization:
+
+```python
+import versionhq as vhq
+
+agent = vhq.Agent(
+   role="Marketing Analyst",
+   goal="my amazing goal"
+) # assuming this agent was created during the network formation
+
+# update the agent
+agent.update(
+   llm="gemini-2.0", # updating LLM (Valid llm_config will be inherited to the new LLM.)
+   tools=[vhq.Tool(func=lambda x: x)], # adding tools
+   max_rpm=3,
+   knowledge_sources=["<KC1>", "<KS2>"], # adding knowledge sources. This will trigger the storage creation.
+   memory_config={"user_id": "0001"}, # adding memories
+   dummy="I am dummy" # <- invalid field will be automatically ignored
+)
+```
+
+<hr />
+
 ## Quick Start
 
 ### Package installation
@@ -92,11 +165,11 @@ You can specify a desired formation or allow the agents to determine it autonomo
    This will form a network with multiple agents on `Formation` and return `TaskOutput` object with output in JSON, plane text, Pydantic model format with evaluation.
 
 
-### Customizing AI agents
+### Executing tasks
 
-You can simply build an agent using `Agent` model.
+You can simply build an agent using `Agent` model and execute the task using `Task` class.
 
-By default, the agent prioritize JSON serializable outputs over plane texts.
+By default, agents prioritize JSON over plane text outputs.
 
 
    ```python
@@ -112,7 +185,6 @@ By default, the agent prioritize JSON serializable outputs over plane texts.
 
 
    agent = vhq.Agent(role="demo", goal="amazing project goal")
-
    task = vhq.Task(
       description="Amazing task",
       pydantic_output=CustomOutput,
@@ -120,7 +192,7 @@ By default, the agent prioritize JSON serializable outputs over plane texts.
       callback_kwargs=dict(message="Hi! Here is the result: ")
    )
 
-   res = task.execute_sync(agent=agent, context="amazing context to consider.")
+   res = task.execute(agent=agent, context="amazing context to consider.")
    print(res)
    ```
 
@@ -176,21 +248,29 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 
 ## Technologies Used
 
+**Graph Theory (Analysis and Visualization)**
+
+* [NetworkX](https://networkx.org/documentation/stable/reference/introduction.html): A Python package to analyze, create, and manipulate complex graph networks.
+* [Matplotlib](https://matplotlib.org/stable/index.html): Visualization library
+* [Graphviz](https://graphviz.org/about/): Graph visualization software
+
+
 **Schema, Data Validation**
 
 * [Pydantic](https://docs.pydantic.dev/latest/): Data validation and serialization library for Python.
 * [Upstage](https://console.upstage.ai/docs/getting-started/overview): Document processer for ML tasks. (Use `Document Parser API` to extract data from documents)
 * [Docling](https://ds4sd.github.io/docling/): Document parsing
 
+
 **Storage**
 
 * [mem0ai](https://docs.mem0.ai/quickstart#install-package): Agents' memory storage and management.
 * [Chroma DB](https://docs.trychroma.com/): Vector database for storing and querying usage data.
 * [SQLite](https://www.sqlite.org/docs.html): C-language library to implements a small SQL database engine.
 
-**LLM-curation**
+**LLM Integration**
 
-* [LiteLLM](https://docs.litellm.ai/docs/providers): Curation platform to access LLMs
+* [LiteLLM](https://docs.litellm.ai/docs/providers): Integration to diverse LLMs
 
 **Tools**
 
@@ -213,6 +293,7 @@ Tasks can be delegated to a team manager, peers in the team, or completely new a
 └── workflows/                # Github actions
 │
 docs/                         # Documentation built by MkDocs
+mkdocs.yml                    # MkDocs config
 │
 src/
 └── versionhq/                # Orchestration framework package
@@ -227,30 +308,32 @@ src/
 │     └── llm/
 │     └── ...
 │
-└── uploads/                  # Local directory that stores uloaded files
+└── uploads/  [.gitignore]    # Local directory to store uploaded files such as graphviz diagrams generatd by `Network` class
+|
+pyproject.toml                # Project config
 
 ```
 
 <hr />
 
-## Setting Up
+## Setting Up a Project
 
-1. Install `uv` package manager:
+### 1. Installing 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. Installing dependencies
 
-2. Install dependencies:
    ```
    uv venv
    source .venv/bin/activate
@@ -258,29 +341,51 @@ src/
    uv sync --all-extras
    ```
 
-* In case of AssertionError/module mismatch, run Python version control using `.pyenv`
-   ```
-   pyenv install 3.12.8
-   pyenv global 3.12.8  (optional: `pyenv global system` to get back to the system default ver.)
-   uv python pin 3.12.8
-   echo 3.12.8 >> .python-version
-   ```
+   - AssertionError/module mismatch errors: Set up default Python version using `.pyenv`
+      ```
+      pyenv install 3.12.8
+      pyenv global 3.12.8  (optional: `pyenv global system` to get back to the system default ver.)
+      uv python pin 3.12.8
+      echo 3.12.8 >> .python-version
+      ```
 
+   - `pygraphviz` related errors: Run the following commands:
+      ```
+      brew install graphviz
+      uv pip install --config-settings="--global-option=build_ext" \
+      --config-settings="--global-option=-I$(brew --prefix graphviz)/include/" \
+      --config-settings="--global-option=-L$(brew --prefix graphviz)/lib/" \
+      pygraphviz
+      ```
+
+      * If the error continues, skip pygraphviz installation by:
+      ```
+      uv sync --all-extras --no-extra pygraphviz
+      ```
+
+   - `torch`/`Docling` related errors: Set up default Python version either `3.11.x` or `3.12.x` (same as AssertionError)
+
+### 3. Adding env secrets to .env file
 
-3. Add secrets to `.env` file in the project root:
+Create `.env` file in the project root and add following:
 
    ```
-   LITELLM_API_KEY=your-litellm-api-key
    OPENAI_API_KEY=your-openai-api-key
+   GEMINI_API_KEY=your-gemini-api-key
+   LITELLM_API_KEY=your-litellm-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
+   [OTHER_LLM_INTERFACE_PROVIDER_OF_YOUR_CHOICE]_API_KEY=your-api-key
    ```
 
 <hr />
 
 ## Contributing
 
+`versionhq` is a open source project.
+
+### Steps
+
 1. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
 
 2. Create amazing features
@@ -288,6 +393,7 @@ src/
 3. Add a test funcition to the `tests` directory and run **pytest**.
 
    - Add secret values defined in `.github/workflows/run_test.yml` to your Github `repository secrets` located at settings > secrets & variables > Actions.
+
    - Run a following command:
       ```
       uv run pytest tests -vv --cache-clear
@@ -299,6 +405,8 @@ src/
 
    * Test functions within the files must begin with `test_`.
 
+   * Pytest priorities are `1. playground demo > 2. docs use cases > 3. other features`
+
 
 4. Update `docs` accordingly.
 
@@ -341,7 +449,7 @@ src/
 
 Pre-commit hooks help maintain code quality by running checks for formatting, linting, and other issues before each commit.
 
-* To skip pre-commit hooks (NOT RECOMMENDED)
+* To skip pre-commit hooks
    ```
    git commit --no-verify -m "your-commit-message"
    ```
@@ -350,7 +458,7 @@ Pre-commit hooks help maintain code quality by running checks for formatting, li
 
 * 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/:
+* We use `mkdocs` to update the docs. You can run the docs locally at http://127.0.0.1:8000/.
 
    ```
    uv run python3 -m mkdocs serve --clean