Paladin Documentation
Welcome to the Paladin documentation! Paladin is a Rust-based enterprise multi-agent orchestration framework built with Hexagonal Architecture and Domain-Driven Design principles.
🚀 Getting Started
New to Paladin? Start here:
- Quickstart Guide - Get your first Paladin agent running in 15 minutes
- Installation - Detailed setup instructions for all platforms
- Examples Gallery - Working code examples for common use cases
📚 User Guides
Learn how to build with Paladin:
- Autonomous Agent Features - 🆕 Auto-planning, prompt generation, dynamic temperature, and agent handoffs (Epic 14)
- Battalion Orchestration - Multi-agent coordination with 8 orchestration patterns
- Maneuver Flow DSL - 🆕 Declarative workflows with Flow DSL syntax (Epic 17)
- Tool Integration (Arsenal) - Integrate external tools via MCP protocol
- Memory Management (Garrison) - Conversation context and persistence
- Output Formatting (Herald) - Format and stream agent responses
- CLI Usage Guide - Complete command-line interface reference
🏗️ Architecture
Understand Paladin's design:
- Architecture Overview - Three-layer hexagonal architecture
- Hexagonal Design - Port/adapter pattern implementation
- Domain Model - DDD entities and relationships
- Design Patterns - Patterns used throughout Paladin
🚢 Deployment
Deploy Paladin to production:
- Docker - Containerized deployment
- Kubernetes - Cloud-native orchestration
- CI/CD - Automated pipelines with GitHub Actions
- Production Best Practices - Security, scaling, and reliability
- Versioning Policy - Lockstep versioning rules and transition criteria
- Release Checklist - Dependency-aware release and publish workflow
🔧 Operations
Monitor and maintain Paladin:
- Logging - Structured logging configuration
- Monitoring - Metrics and dashboards
- Troubleshooting - Common issues and solutions
- Performance Tuning - Optimize for throughput and latency
🤝 Contributing
Extend and improve Paladin:
- Contribution Guide - How to contribute
- Adapter Development - Create custom adapters
- Testing Guide - Testing requirements and patterns
📖 API Reference
Comprehensive API documentation is available via rustdoc:
cargo doc --open
Or browse online at: https://docs.rs/paladin (when published)
🎯 Key Concepts
Medieval Military Theme
Paladin uses a consistent Medieval Military naming convention:
| Term | Definition |
|---|---|
| Paladin | An autonomous AI agent |
| Battalion | A coordinated group of Paladins |
| Formation | Sequential Paladin execution |
| Phalanx | Concurrent Paladin execution |
| Campaign | Graph-based orchestration |
| Chain of Command | Hierarchical delegation |
| Maneuver | Flow DSL declarative orchestration |
| Garrison | Agent memory storage |
| Arsenal | Tool and capability registry |
| Armament | A single tool |
| Citadel | State persistence system |
| Herald | Output formatting |
Architecture Layers
Paladin follows hexagonal (ports and adapters) architecture:
- Core Layer - Pure domain logic, no external dependencies
- Application Layer - Use cases and port definitions (interfaces)
- Infrastructure Layer - Adapter implementations for external systems
Dependencies flow inward only: Infrastructure → Application → Core
💡 Support
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Documentation: You're reading it!
📄 License
See LICENSE for details.