Skip to content

🧠 DeepAgents Documentation Index

Complete navigation guide for all DeepAgents resources. Start here to find exactly what you need!

🚀 Quick Start (30 Minutes)

New to DeepAgents? Start here:

What you'll learn: - Set up Gemini API (FREE) - Build your first DeepAgents agent - Run real queries with Gemini - Evaluate with BDD scenarios - Optimize with GEPA (+200% improvement!) - Deploy production-ready agents

Time: 30-45 minutes
Cost: $0.00 (FREE Gemini!)
Result: Production-ready agent

📚 Core Guides

DeepAgents Integration Guide

Complete reference for DeepAgents in SuperOptiX

Topics covered: - What is DeepAgents? - Installation and setup - Quick start examples - Backend configuration (0.2.0) - Creating custom playbooks - Complete workflow - Troubleshooting - FAQ

When to read: After completing the end-to-end workflow
Length: Comprehensive (~1,300 lines)

Backend Configuration Reference

Deep dive into DeepAgents 0.2.0 backends

Topics covered: - What are backends? - StateBackend (ephemeral) - StoreBackend (persistent) - FilesystemBackend (real files) - CompositeBackend (hybrid) - Configuration syntax - Best practices - Troubleshooting

When to read: When you need persistent memory or file access
Length: ~670 lines

🎓 Hands-On Tutorials

Backend Tutorial

6 practical tutorials with working examples

Tutorials: 1. Persistent Chatbot (StoreBackend) 2. Code Review Agent (FilesystemBackend) 3. Hybrid Research Agent (CompositeBackend) 4. GEPA Optimization with Backends 5. Backend Performance Comparison 6. Production-Ready Hybrid Agent

When to use: When you want to practice with each backend type
Time: 2-3 hours for all tutorials

🔧 Setup & Configuration

Gemini Configuration Guide

Complete Gemini 2.5 model configuration guide

Topics: - Gemini 2.5 model lineup (Flash vs Pro) - Recommended configurations - Performance comparisons - Cost analysis (FREE tier) - Troubleshooting

When to read: Before starting, to optimize model selection
Length: Comprehensive model reference

Gemini Testing Guide

Step-by-step Gemini testing workflow

Topics: - Getting FREE Gemini API key - Setting up environment - Testing workflow - Expected outputs - Before/after optimization examples - Troubleshooting

When to use: When setting up Gemini for the first time

📖 Reference Materials

Quick Reference Card

One-page cheat sheet (print and keep handy!)

Contains: - Essential commands - Backend quick configs - Model configurations - Common issues and fixes

When to use: As a quick lookup during development

🔍 Technical Deep Dives

Integration Summary

What's new in 0.2.0 integration

Topics: - Feature overview - Implementation status - What's working - How to use new features - Migration guide

Technical Analysis

Why Ollama doesn't work with DeepAgents

Topics: - Root cause analysis - Function-calling requirements - Framework comparison - Workarounds and alternatives

When to read: If you tried Ollama and it didn't work

Bug Fixes Summary

All bugs that were fixed

Topics: - Class name resolution fix - Execution method fix - Model format fix - Testing results

When to use: If you encounter issues

🎯 Use Case Guides

Building a Persistent Chatbot

Read: 1. Complete Workflow - Example 1 2. Backend Tutorial - Tutorial 1 3. Backend Reference - StoreBackend section

Demo Agent: 

super agent pull chatbot_persistent

Building a Code Review Agent

Read: 1. Complete Workflow - Example 2 2. Backend Tutorial - Tutorial 2 3. Backend Reference - FilesystemBackend section

Demo Agent: 

super agent pull code_reviewer

Building a Research Assistant

Read: 1. Complete Workflow - Example 3 2. Backend Tutorial - Tutorial 3 3. Backend Reference - CompositeBackend section

Demo Agent: 

super agent pull researcher_hybrid

📊 Documentation Matrix

Document Type Length Difficulty Time Best For
Complete Workflow Tutorial Long Beginner 30 min Start here!
Integration Guide Reference Very Long Intermediate 1 hour Complete reference
Backend Reference Reference Long Intermediate 45 min Backend deep dive
Backend Tutorial Tutorial Long Intermediate 2 hours Hands-on practice
Gemini Config Guide Medium Beginner 15 min Model setup
Quick Reference Cheat Sheet Short All 5 min Quick lookup

"How do I get started?"

→ Complete End-to-End Workflow

"How do I make memory persist?"

→ Backend Reference - StoreBackend

"How do I access real files?"

→ Backend Reference - FilesystemBackend

"How do I optimize my agent?"

→ Complete Workflow - Step 7

"Why can't I use Ollama?"

→ Technical Analysis

"How do I set up Gemini?"

→ Gemini Testing Guide

🎉 Demo Agents

All demo agents are production-ready and fully documented:

# Basic Research (StateBackend)
super agent pull research_agent_deepagents
# Uses: Default ephemeral storage
# Best for: Single-session research

# Persistent Chatbot (StoreBackend)
super agent pull chatbot_persistent
# Uses: Persistent database storage
# Best for: Multi-session conversations

# Code Reviewer (FilesystemBackend)
super agent pull code_reviewer
# Uses: Real filesystem access
# Best for: Project analysis

# Hybrid Researcher (CompositeBackend)
super agent pull researcher_hybrid
# Uses: Hybrid storage strategy
# Best for: Production systems

🆘 Getting Help

Documentation Not Helping?

  1. Check Troubleshooting Section
  2. Read FAQ
  3. Check Common Issues

Still Stuck?

🌟 Community Examples

Built something with DeepAgents? Share it!

Ready to start? Begin with the Complete End-to-End Workflow! 🚀