# Oshun AI Integration Workshops

Interactive workshops for learning the Oshun AI provider integrations.
Each workshop includes hands-on exercises, discussion points, and
take-home assignments.

## Available Workshops

### Workshop 1: Getting Started with Oshun AI Integrations

**File:** `workshop-01-getting-started.md`
**Duration:** 2 hours
**Level:** Beginner

Learn the fundamentals:
- Provider initialization and configuration
- Text-to-speech with ElevenLabs
- Image generation with ComfyUI/RunComfy
- Model discovery with Civitai
- Basic error handling

### Workshop 2: Production Patterns for AI Integrations

**File:** `workshop-02-production-patterns.md`
**Duration:** 3 hours
**Level:** Intermediate

Build production-ready applications:
- Streaming audio synthesis
- Batch processing with concurrency control
- Resilience patterns (retry, circuit breaker, fallback)
- Resource management (pools, cleanup)
- Observability and metrics

### Workshop 3: Advanced Architecture (Coming Soon)

**Duration:** 4 hours
**Level:** Advanced

Master complex systems:
- Multi-provider orchestration
- Workflow DAGs
- Distributed tracing
- Performance optimization
- Security and compliance

## Workshop Format

Each workshop follows this structure:

```
┌─────────────────────────────────────────────────────────────┐
│  Introduction (10-15 min)                                   │
│  - Overview and objectives                                  │
│  - Setup and prerequisites                                  │
├─────────────────────────────────────────────────────────────┤
│  Part 1-N (20-30 min each)                                  │
│  - Concept explanation                                      │
│  - Code walkthrough                                         │
│  - Hands-on exercise                                        │
│  - Discussion                                               │
├─────────────────────────────────────────────────────────────┤
│  Break (if > 2 hours)                                       │
├─────────────────────────────────────────────────────────────┤
│  Q&A and Wrap-up (10-15 min)                               │
│  - Key takeaways                                            │
│  - Homework assignments                                     │
│  - Next steps                                               │
└─────────────────────────────────────────────────────────────┘
```

## Conducting Workshops

### For Facilitators

1. **Before the Workshop**
   - Review all material and exercises
   - Test all code examples with current API keys
   - Prepare environment with dependencies installed
   - Have backup solutions ready

2. **During the Workshop**
   - Start with a quick check of prerequisites
   - Pace according to participant progress
   - Encourage questions and discussion
   - Provide hints rather than full solutions

3. **After the Workshop**
   - Share solution files
   - Provide feedback forms
   - Follow up on homework

### For Participants

1. **Preparation**
   - Install required dependencies
   - Obtain API keys for all services
   - Review prerequisites from previous workshops
   - Come with questions

2. **During**
   - Type code yourself (don't just copy)
   - Ask questions when stuck
   - Help other participants
   - Take notes on key concepts

3. **After**
   - Complete homework assignments
   - Review solutions and compare
   - Practice concepts in personal projects

## Self-Paced Learning

Workshops can be completed independently:

1. Read through the material
2. Complete each exercise before moving on
3. Check your work against solutions
4. Complete the homework assignment
5. Move to the next workshop

Recommended pace:
- Workshop 1: 1-2 days
- Workshop 2: 2-3 days
- Workshop 3: 3-5 days

## Workshop Prerequisites

### Technical Requirements

- Node.js 18+
- pnpm package manager
- Git
- Code editor (VS Code recommended)

### API Keys Required

| Workshop | ElevenLabs | RunComfy | Civitai |
|----------|------------|----------|---------|
| 1        | Required   | Required | Optional |
| 2        | Required   | Required | Optional |
| 3        | Required   | Required | Required |

### Knowledge Prerequisites

| Workshop | Prerequisites |
|----------|--------------|
| 1 | Basic TypeScript |
| 2 | Workshop 1, async/await |
| 3 | Workshop 2, distributed systems concepts |

## Suggested Learning Path

```
Week 1: Foundations
├── Day 1-2: Workshop 1
├── Day 3-4: Beginner exercises
└── Day 5: Review and practice

Week 2: Production Patterns
├── Day 1-2: Workshop 2 (Part 1-2)
├── Day 3: Workshop 2 (Part 3-5)
├── Day 4-5: Intermediate exercises
└── Weekend: Homework project

Week 3: Advanced Concepts
├── Day 1-2: Workshop 3 (Part 1-2)
├── Day 3-4: Workshop 3 (Part 3-5)
└── Day 5: Advanced exercises

Week 4: Capstone
├── Day 1-3: Build complete project
├── Day 4: Review and refine
└── Day 5: Present/document
```

## Related Resources

- [Code Examples](../examples/README.md) - Reference implementations
- [Exercises](../exercises/README.md) - Practice problems
- [Video Scripts](../videos/README.md) - Visual walkthroughs
- [API Documentation](../../integrations/) - Detailed reference

## Contributing

To create a new workshop:

1. Follow the existing format and structure
2. Include learning objectives
3. Provide time estimates
4. Include hands-on exercises for each concept
5. Add discussion questions
6. Create homework assignments
7. Update this README