robot_lab 0.0.1

data/docs/getting-started/installation.md

@@ -0,0 +1,179 @@
+# Installation
+
+This guide covers installing RobotLab in your Ruby project.
+
+## Requirements
+
+- **Ruby**: 3.1 or higher
+- **Bundler**: 2.0 or higher (recommended)
+
+## Install via Bundler
+
+Add RobotLab to your `Gemfile`:
+
+```ruby
+gem "robot_lab"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+## Install via RubyGems
+
+Or install directly:
+
+```bash
+gem install robot_lab
+```
+
+## Dependencies
+
+RobotLab automatically installs these dependencies:
+
+| Gem | Purpose |
+|-----|---------|
+| `ruby_llm` | LLM provider integrations |
+| `ruby_llm-template` | Template rendering for prompts |
+| `simple_flow` | Workflow execution |
+
+### Optional Dependencies
+
+For specific features, you may need additional gems:
+
+=== "MCP WebSocket Transport"
+
+    ```ruby
+    gem "async-websocket"
+    ```
+
+=== "MCP HTTP Transport"
+
+    ```ruby
+    gem "async-http"
+    ```
+
+=== "Rails Integration"
+
+    ```ruby
+    # Rails is detected automatically
+    gem "rails", ">= 7.0"
+    ```
+
+## Verify Installation
+
+Create a test file to verify everything works:
+
+```ruby
+# test_robot_lab.rb
+require "robot_lab"
+
+puts "RobotLab version: #{RobotLab::VERSION}"
+puts "Installation successful!"
+```
+
+Run it:
+
+```bash
+ruby test_robot_lab.rb
+# => RobotLab version: 0.0.1
+# => Installation successful!
+```
+
+## Rails Installation
+
+For Rails applications, use the install generator:
+
+```bash
+rails generate robot_lab:install
+```
+
+This creates:
+
+- `config/initializers/robot_lab.rb` - Configuration file
+- `db/migrate/*_create_robot_lab_tables.rb` - Database migrations
+- `app/models/robot_lab_thread.rb` - Thread model
+- `app/models/robot_lab_result.rb` - Result model
+- `app/robots/` - Directory for robot definitions
+- `app/tools/` - Directory for tool definitions
+
+Then run migrations:
+
+```bash
+rails db:migrate
+```
+
+## Environment Setup
+
+Before using RobotLab, set up your API keys as environment variables:
+
+=== "Anthropic (Recommended)"
+
+    ```bash
+    export ANTHROPIC_API_KEY="sk-ant-..."
+    ```
+
+=== "OpenAI"
+
+    ```bash
+    export OPENAI_API_KEY="sk-..."
+    ```
+
+=== "Google Gemini"
+
+    ```bash
+    export GEMINI_API_KEY="..."
+    ```
+
+!!! tip "Using dotenv"
+    For development, consider using the [dotenv](https://github.com/bkeepers/dotenv) gem to manage environment variables:
+
+    ```ruby
+    # Gemfile
+    gem "dotenv-rails", groups: [:development, :test]
+    ```
+
+    ```bash
+    # .env
+    ANTHROPIC_API_KEY=sk-ant-...
+    ```
+
+## Troubleshooting
+
+### Gem Installation Fails
+
+If you encounter SSL or network errors:
+
+```bash
+# Update RubyGems
+gem update --system
+
+# Try installing with verbose output
+gem install robot_lab --verbose
+```
+
+### Missing Dependencies
+
+If you see "LoadError" for optional gems:
+
+```bash
+# Install the specific gem mentioned in the error
+bundle add async-websocket
+```
+
+### API Key Issues
+
+If you see authentication errors:
+
+1. Verify your API key is set: `echo $ANTHROPIC_API_KEY`
+2. Check the key is valid in your provider's console
+3. Ensure you're using the correct environment variable name
+
+## Next Steps
+
+Now that RobotLab is installed:
+
+- [:octicons-arrow-right-24: Quick Start](quick-start.md) - Build your first robot
+- [:octicons-arrow-right-24: Configuration](configuration.md) - Configure defaults

data/docs/getting-started/quick-start.md

@@ -0,0 +1,203 @@
+# Quick Start
+
+Build your first RobotLab application in 5 minutes.
+
+## Step 1: Configure RobotLab
+
+First, set up your API credentials:
+
+```ruby
+require "robot_lab"
+
+RobotLab.configure do |config|
+  config.anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
+  config.default_model = "claude-sonnet-4"
+end
+```
+
+## Step 2: Create a Robot
+
+Build a simple assistant robot:
+
+```ruby
+assistant = RobotLab.build do
+  name "assistant"
+  description "A helpful AI assistant"
+
+  template <<~PROMPT
+    You are a helpful AI assistant. You provide clear, accurate,
+    and concise answers to questions. Be friendly but professional.
+  PROMPT
+end
+```
+
+## Step 3: Create a Network
+
+Add your robot to a network:
+
+```ruby
+network = RobotLab.create_network do
+  name "my_first_network"
+  add_robot assistant
+end
+```
+
+## Step 4: Run It!
+
+Execute the network with a message:
+
+```ruby
+# Create state with your message
+state = RobotLab.create_state(message: "What is Ruby on Rails?")
+
+# Run the network
+result = network.run(state: state)
+
+# Get the response
+response = result.last_result.output.first.content
+puts response
+```
+
+## Complete Example
+
+Here's everything together in one file:
+
+```ruby title="hello_robot.rb"
+require "robot_lab"
+
+# Configure
+RobotLab.configure do |config|
+  config.anthropic_api_key = ENV["ANTHROPIC_API_KEY"]
+  config.default_model = "claude-sonnet-4"
+end
+
+# Build robot
+assistant = RobotLab.build do
+  name "assistant"
+  description "A helpful AI assistant"
+  template "You are a helpful AI assistant."
+end
+
+# Create network
+network = RobotLab.create_network do
+  name "hello_network"
+  add_robot assistant
+end
+
+# Run
+state = RobotLab.create_state(message: "Hello! What can you help me with?")
+result = network.run(state: state)
+
+puts result.last_result.output.first.content
+```
+
+Run it:
+
+```bash
+ruby hello_robot.rb
+```
+
+## Adding a Tool
+
+Make your robot more capable with tools:
+
+```ruby
+assistant = RobotLab.build do
+  name "assistant"
+  description "An assistant that can tell time"
+
+  template <<~PROMPT
+    You are a helpful assistant. Use the current_time tool
+    when users ask about the time.
+  PROMPT
+
+  tool :current_time do
+    description "Get the current date and time"
+    handler { Time.now.strftime("%Y-%m-%d %H:%M:%S") }
+  end
+end
+```
+
+Now the robot can respond to "What time is it?" by calling the tool.
+
+## Multi-Robot Example
+
+Create a network with multiple specialized robots:
+
+```ruby
+# Classifier robot
+classifier = RobotLab.build do
+  name "classifier"
+  description "Classifies incoming requests"
+  template <<~PROMPT
+    Classify the user's request into one category:
+    - QUESTION: General knowledge questions
+    - MATH: Mathematical calculations
+    - OTHER: Everything else
+
+    Respond with only the category name.
+  PROMPT
+end
+
+# Question answerer
+answerer = RobotLab.build do
+  name "answerer"
+  description "Answers general questions"
+  template "You answer general knowledge questions accurately."
+end
+
+# Calculator
+calculator = RobotLab.build do
+  name "calculator"
+  description "Handles math problems"
+  template "You solve mathematical problems step by step."
+end
+
+# Network with routing
+network = RobotLab.create_network do
+  name "smart_assistant"
+  add_robot classifier
+  add_robot answerer
+  add_robot calculator
+
+  router ->(args) {
+    case args.call_count
+    when 0
+      :classifier
+    when 1
+      result = args.last_result&.output&.first&.content&.strip
+      case result
+      when "QUESTION" then :answerer
+      when "MATH" then :calculator
+      else :answerer
+      end
+    else
+      nil
+    end
+  }
+end
+```
+
+## What's Next?
+
+You've built your first RobotLab application! Here's where to go next:
+
+<div class="grid cards" markdown>
+
+-   [:octicons-gear-24: **Configuration**](configuration.md)
+
+    Learn all configuration options
+
+-   [:octicons-cpu-24: **Building Robots**](../guides/building-robots.md)
+
+    Deep dive into robot creation
+
+-   [:octicons-tools-24: **Using Tools**](../guides/using-tools.md)
+
+    Give robots custom capabilities
+
+-   [:octicons-git-branch-24: **Creating Networks**](../guides/creating-networks.md)
+
+    Advanced network patterns
+
+</div>