Updating docs and adding github workflow to deploy docs to github pages

Author: TonsOfFun

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [docs]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v3 # Uncomment this block if you're using pnpm
+      #   with:
+      #     version: 9 # Not needed if you've set "packageManager" in package.json
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.vitepress/assets/icons/openrouter.svg

@@ -3,6 +3,7 @@ import { defineConfig } from 'vitepress'
 import {
   groupIconMdPlugin,
   groupIconVitePlugin,
+  localIconLoader,
 } from "vitepress-plugin-group-icons"
 
 // https://vitepress.dev/reference/site-config
@@ -20,6 +21,7 @@ export default defineConfig({
           anthropic: 'logos:anthropic-icon',
           google: 'logos:google-icon',
           ollama: 'simple-icons:ollama',
+          openrouter: localIconLoader(import.meta.url, './assets/icons/openrouter.svg'),
         }
       }),
     ],

docs/.vitepress/config.mts

@@ -46,6 +46,7 @@ class ApplicationAgent < ActiveAgent::Base
   generate_with :openai
 
   before_action :set_context
+  
   private
   def set_context
     # Logic to set the context for the action, e.g., setting a user ID or session data
@@ -62,7 +63,8 @@ Generation callbacks are executed during the generation process of an agent. Thi
 class ApplicationAgent < ActiveAgent::Base
   generate_with :openai
 
-  after_generate :process_response
+  after_generation :process_response
+
   private
   def process_response 
     generation_provider.response

docs/docs/active-agent/callbacks.md

@@ -17,6 +17,8 @@ The prompt generation cycle is similar to the request-response cycle of Action C
 6. **Updated Context**: The context is updated with the new messages, actions, and parameters, and the cycle continues.
 ## Prompt Context
 Action Prompt renders prompt context objects that represent the contextual data and runtime parameters for the generation process. Prompt context objects contain messages, actions, and params that are passed in the request to the agent's generation provider. The context object is responsible for managing the contextual history and providing the necessary information for prompt and response cycles.
+
+
 ## Example Prompt Generation
 
 ```ruby
@@ -33,6 +35,7 @@ response = ApplicationAgent.text_prompt(messages: response.prompt.messages).gene
 Generation can be performed using Active Job to handle the prompt-generation and perform actions asynchronously. This is the most common way to handle generation in production applications, as it allows for better scalability and responsiveness.
 
 To perform queued generation, you can use the `generate_later` method, which enqueues the generation job to be processed later by Active Job. 
+
 ```ruby
 response = ApplicationAgent.text_prompt(message: params[:message], messages: response.prompt.messages).generate_later
 ```

docs/docs/active-agent/generation.md

@@ -9,7 +9,7 @@ Agents are Controllers that act as the core of the Active Agent framework. They
 
 ## Example
 ```ruby
-class TravelAgent < ActiveAgent::Base
+class TravelAgent < ApplicationAgent
   def search
     prompt(message: params[:message], content_type: :html)
   end

docs/docs/framework/active-agent.md

@@ -4,11 +4,7 @@ Generation Providers are the backbone of the Active Agent framework, allowing se
 
 ::: code-group
 
-```ruby [OpenAI]
-class ApplicationAgent < ActiveAgent::Base
-  generate_with :openai
-end
-```
+<<< @/../test/dummy/app/agents/open_ai_agent.rb#snippet{ruby:line-numbers} [OpenAI]
 
 ```ruby [Anthropic]
 class ApplicationAgent < ActiveAgent::Base
@@ -22,8 +18,8 @@ class ApplicationAgent < ActiveAgent::Base
 end
 ```
 
-<<< @/../test/dummy/app/agents/open_router_agent.rb#snippet{ruby:line-numbers} [openrouter]
+<<< @/../test/dummy/app/agents/open_router_agent.rb#snippet{ruby:line-numbers} [OpenRouter]
 
-<<< @/../test/dummy/app/agents/ollama_agent.rb#snippet{ruby:line-numbers} [ollama]
+<<< @/../test/dummy/app/agents/ollama_agent.rb#snippet{ruby:line-numbers} [Ollama]
 
 :::