Update docs and Gh actions

.github/workflows/docs-check.yml

@@ -20,12 +20,11 @@ jobs:
         uses: snok/install-poetry@v1
         with:
           virtualenvs-in-project: true
-      - name: Install dependencies
-        run: |
-          poetry install --all-extras
 
       - name: Build documentation
-        run: mkdocs build --strict 2>&1 | tee build-log.txt
+        run: |
+          poetry install --with dev
+          poetry run mkdocs build --strict 2>&1 | tee build-log.txt
 
       - name: Check for warnings
         run: |

.github/workflows/docs.yml

@@ -25,9 +25,8 @@ jobs:
         uses: snok/install-poetry@v1
         with:
           virtualenvs-in-project: true
-      - name: Install dependencies
-        run: |
-          poetry install --all-extras
 
       - name: Deploy documentation
-        run: mkdocs gh-deploy --force
+        run: |
+          poetry install --with dev
+          poetry run mkdocs gh-deploy --force

.gitignore

@@ -1,4 +1,5 @@
 build-log.txt
+poetry.lock
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

docs/README.md

@@ -15,7 +15,7 @@ To build the documentation locally:
 
 ```bash
 # Install development dependencies if you haven't already
-pip install -e ".[dev]"
+poetry install --with dev
 
 # Build the docs
 mkdocs build

docs/examples/email.md

@@ -6,7 +6,7 @@ This example demonstrates how to create an agent that can access and manage Gmai
 
 Before running this example, make sure you have:
 
-1. Installed `agents-arcade` (see [Installation](installation.md))
+1. Installed `agents-arcade` (see [Installation](../getting-started/installation.md))
 2. An Arcade API key (sign up at [arcade.dev](https://arcade.dev) if you don't have one)
 3. An [OpenAI API Key](https://platform.openai.com/docs/libraries#create-and-export-an-api-key).
 4. Set the `ARCADE_API_KEY` environment variable or have your API key ready to use

docs/examples/github.md

@@ -6,7 +6,7 @@ This example shows how to create an agent that can interact with GitHub using Ar
 
 Before running this example, make sure you have:
 
-1. Installed `agents-arcade` (see [Installation](installation.md))
+1. Installed `agents-arcade` (see [Installation](../getting-started/installation.md))
 2. An Arcade API key (sign up at [arcade.dev](https://arcade.dev) if you don't have one)
 3. An [OpenAI API Key](https://platform.openai.com/docs/libraries#create-and-export-an-api-key).
 4. Set the `ARCADE_API_KEY` environment variable or have your API key ready to use

docs/examples/multi-toolkit.md

@@ -14,7 +14,7 @@ One of the most powerful features of Agents Arcade is the ability to combine mul
 
 Before running this example, make sure you have:
 
-1. Installed `agents-arcade` (see [Installation](installation.md))
+1. Installed `agents-arcade` (see [Installation](../getting-started/installation.md))
 2. An Arcade API key (sign up at [arcade.dev](https://arcade.dev) if you don't have one)
 3. An [OpenAI API Key](https://platform.openai.com/docs/libraries#create-and-export-an-api-key).
 4. Set the `ARCADE_API_KEY` environment variable or have your API key ready to use

mkdocs.yml

@@ -46,6 +46,9 @@ plugins:
             show_root_heading: true
             heading_level: 3
 
+exclude_docs: |
+  README.md
+
 nav:
   - Home: index.md
   - Getting Started:

pyproject.toml

@@ -29,20 +29,18 @@ classifiers = [
 Homepage = "https://github.com/ArcadeAI/agents-arcade"
 Repository = "https://github.com/ArcadeAI/agents-arcade"
 
-[dependency-groups]
-dev = [
-    "mypy",
-    "ruff==0.9.2",
-    "pytest",
-    "pytest-asyncio",
-    "pytest-mock>=3.14.0",
-    "rich",
-    "mkdocs>=1.6.0",
-    "mkdocs-material>=9.6.0",
-    "mkdocstrings[python]>=0.28.0",
-    "coverage>=7.6.12",
-    "playwright==1.50.0",
-]
+[tool.poetry.group.dev.dependencies]
+mypy = "*"
+ruff = "0.9.2"
+pytest = "*"
+pytest-asyncio = "*"
+pytest-mock = ">=3.14.0"
+rich = "*"
+mkdocs = ">=1.6.0"
+mkdocs-material = ">=9.6.0"
+mkdocstrings = {extras = ["python"], version = ">=0.28.0"}
+coverage = ">=7.6.12"
+playwright = "==1.50.0"
 
 [build-system]
 requires = ["hatchling"]