Vapora/docs/src/intro.md

112 lines
3.7 KiB
Markdown
Raw Normal View History

# Welcome to VAPORA Documentation
VAPORA is an **intelligent development orchestration platform** built entirely in Rust. It combines multi-agent coordination, cost-aware LLM routing, and knowledge graph learning to automate complex development workflows.
## Quick Links
- **[Getting Started](../getting-started.md)** — New to VAPORA? Start here
- **[Quickstart Guide](../quickstart.md)** — Get up and running in minutes
- **[Examples & Tutorials](../examples-guide.md)** — Learn through practical examples
- **[Architecture](../architecture/vapora-architecture.md)** — Understand the design
## Core Features
### 🤖 Learning-Based Agent Orchestration
- Multi-agent coordination with learning profiles
- Per-task-type expertise tracking from execution history
- Recency bias: recent 7 days weighted 3× higher
- Confidence scoring prevents overfitting on small samples
### 💰 Cost-Aware LLM Routing
- Multi-provider support: Claude, OpenAI, Gemini, Ollama
- Per-role budget enforcement (monthly/weekly limits)
- Three-tier enforcement: normal → caution → exceeded
- Automatic fallback to cheaper providers under budget pressure
### 📊 Knowledge Graph
- Temporal execution history with causal relationships
- Learning curves computed from daily aggregations
- Semantic similarity search for solution recommendations
- Pattern matching for problem solving
### 🐝 Swarm Coordination
- Agent registration with capability-based filtering
- Load-balanced task assignment
- Prometheus metrics for real-time monitoring
- NATS JetStream optional (graceful fallback)
### 🔌 Full-Stack Rust
- **Backend**: Axum REST API (40+ endpoints)
- **Frontend**: Leptos WASM UI (Kanban board, glassmorphism)
- **Database**: SurrealDB multi-tenant persistence
- **Async**: Tokio runtime for high-performance I/O
## Platform Architecture
```
User UI (Leptos WASM)
REST API (Axum, 40+ endpoints)
SurrealDB (Multi-tenant scopes)
Agent Job Queue (NATS JetStream)
Agent Runtime
LLM Router (Multi-provider)
Provider APIs + MCP Gateway
```
## Documentation Structure
- **[Setup & Deployment](../setup/README.md)** — Installation and configuration
- **[Features](../features/README.md)** — Platform capabilities
- **[Architecture](../architecture/README.md)** — Design and patterns
- **[ADRs](../adrs/README.md)** — Architecture decision records
- **[Integrations](../integrations/README.md)** — Integration guides
- **[Operations](../operations/README.md)** — Runbooks and procedures
- **[Disaster Recovery](../disaster-recovery/README.md)** — Recovery procedures
## Learning Paths
### 30 minutes: Quick Overview
1. [Getting Started](../getting-started.md)
2. [Quick Start](../quickstart.md)
3. [Platform Capabilities](../features/overview.md)
### 90 minutes: System Integration
1. Setup & Deployment
2. Multi-Agent Workflows
3. LLM Routing Examples
4. Learning Profiles
### 2-3 hours: Production Ready
1. Complete Architecture
2. All Integration Guides
3. Operations Runbooks
4. Disaster Recovery Procedures
## Key Resources
| Resource | Purpose |
|----------|---------|
| **Architecture** | Understand system design and components |
| **ADRs** | Learn decision rationale for each component |
| **Examples** | Copy working code patterns |
| **Runbooks** | Handle operational scenarios |
| **Integration Guides** | Connect with external systems |
## Community & Support
- **Repository**: [github.com/vapora-platform/vapora](https://github.com/vapora-platform/vapora)
- **Issues**: Report bugs and request features
- **Discussions**: Ask questions and share ideas
---
**Platform Version**: 1.2.0 (Production Ready)
**Documentation Version**: 1.2.0
**Last Updated**: 2026-01-12