Merge pull request #6 from redpanda-data/docs

Author: rockwotj

.github/workflows/ci.yaml

@@ -18,6 +18,8 @@ jobs:
             task: 'tests'
           - name: 'Run Ruff'
             task: 'lint'
+          - name: 'Build docs'
+            task: 'build-docs'
     name: ${{ matrix.variant.name }}
     runs-on: ubuntu-latest
     steps:

.github/workflows/docs.yaml

@@ -0,0 +1,23 @@
+name: Deploy Documentation
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        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
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install Task
+        uses: arduino/setup-task@v2
+      - name: Deploy Documentation
+        run: task deploy-docs

docs/reference/agents.md

@@ -0,0 +1,3 @@
+# Agents module
+
+::: redpanda.agents

docs/reference/index.md

@@ -0,0 +1,3 @@
+# Runtime module
+
+::: redpanda.runtime

docs/reference/runtime.md

@@ -25,7 +25,8 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          paths: ["src/agents"]
+          paths: 
+            - "src/redpanda"
           options:
             docstring_style: google
             # Shows links to other members in signatures
@@ -69,4 +70,4 @@ validation:
   anchors: warn
 
 watch:
-  - "src/agents"
+  - "src/redpanda"

mkdocs.yml

@@ -19,6 +19,14 @@
 
 
 async def serve(agent: Agent) -> None:
+    """
+    Serve an agent as a Redpanda Connect processor plugin.
+
+    This method runs for the entire lifetime of the server.
+
+    Args:
+        agent: The agent to serve.
+    """
     addr = os.getenv("REDPANDA_CONNECT_AGENT_RUNTIME_MCP_SERVER")
     if addr:
         agent.mcp.append(SSEMCPEndpoint(addr))