helios-engine 0.4.1

# Helios Documentation

This directory contains comprehensive documentation for the Helios Engine framework. Whether you're getting started, building advanced applications, or contributing to the project, you'll find detailed guides and references here.

## 📚 Documentation Overview

The documentation is organized to support different user needs and experience levels:

- **Getting Started**: Quick start guides and tutorials
- **Reference**: API documentation and architecture details
- **Advanced**: In-depth technical documentation

## 📋 Documentation Files

### 🚀 Getting Started

| File | Description | Audience |
|------|-------------|----------|
| **[QUICKSTART.md](QUICKSTART.md)** | 5-minute setup guide to get Helios running | New users |
| **[INSTALLATION.md](INSTALLATION.md)** | Complete installation instructions and feature flags | New users |
| **[TUTORIAL.md](TUTORIAL.md)** | Step-by-step tutorial building a complete agent | Beginners |

### 💻 Usage & Configuration

| File | Description | Audience |
|------|-------------|----------|
| **[USAGE.md](USAGE.md)** | CLI usage patterns, examples, and common workflows | Intermediate users |
| **[CONFIGURATION.md](CONFIGURATION.md)** | Complete configuration guide with all providers and local inference | Intermediate users |
| **[TOOLS.md](TOOLS.md)** | Built-in tools documentation and custom tool creation | Intermediate users |

### 📖 Reference Documentation

| File | Description | Audience |
|------|-------------|----------|
| **[API.md](API.md)** | Complete API reference with all modules, structs, and functions | Developers |
| **[ARCHITECTURE.md](ARCHITECTURE.md)** | System architecture, design principles, and component interactions | Architects/Contributors |
| **[FOLDER_STRUCTURE.md](FOLDER_STRUCTURE.md)** | Project organization and file structure explanation | Contributors |
| **[PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md)** | High-level project description and goals | All users |

### 🔧 Advanced Topics

| File | Description | Audience |
|------|-------------|----------|
| **[ADVANCED.md](ADVANCED.md)** | Advanced features: Forest of Agents, performance, security | Advanced users |
| **[RAG.md](RAG.md)** | Retrieval-Augmented Generation implementation guide | Advanced users |
| **[STREAMING.md](STREAMING.md)** | Real-time streaming responses and implementation | Developers |
| **[IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)** | Technical implementation details | Contributors |

### 🛠️ Special Guides

| File | Description | Audience |
|------|-------------|----------|
| **[USING_AS_CRATE.md](USING_AS_CRATE.md)** | Using Helios as a Rust library crate | Library users |
| **[QUICKREF.md](QUICKREF.md)** | Quick reference for common operations | Experienced users |

## 🎯 Reading Guide

### For New Users
1. Start with **[INSTALLATION.md](INSTALLATION.md)** to install Helios Engine
2. Follow **[QUICKSTART.md](QUICKSTART.md)** to get up and running quickly
3. Learn with **[TUTORIAL.md](TUTORIAL.md)** for hands-on agent building

### For Intermediate Users
1. Explore **[USAGE.md](USAGE.md)** for CLI usage patterns and examples
2. Configure with **[CONFIGURATION.md](CONFIGURATION.md)** for different providers
3. Discover **[TOOLS.md](TOOLS.md)** for built-in tools and custom tool creation

### For Developers
1. Read **[API.md](API.md)** for complete function signatures and usage
2. Study **[ARCHITECTURE.md](ARCHITECTURE.md)** for system understanding
3. Reference **[QUICKREF.md](QUICKREF.md)** for common operations

### For Contributors
1. Review **[PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md)** for project vision
2. Study **[ARCHITECTURE.md](ARCHITECTURE.md)** and **[FOLDER_STRUCTURE.md](FOLDER_STRUCTURE.md)**
3. Read **[IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)** for technical details

## 📖 Content Categories

### User-Facing Documentation
- Installation and setup guides
- Tutorials and examples
- Usage patterns and best practices
- Configuration options

### Developer Documentation
- API references and signatures
- Architecture and design decisions
- Implementation details
- Contributing guidelines

### Technical Documentation
- System architecture diagrams
- Component interactions
- Performance considerations
- Security considerations

## 🔍 Finding Information

### Search by Topic

**Installation & Setup:**
- [INSTALLATION.md](INSTALLATION.md) - Installation instructions
- [QUICKSTART.md](QUICKSTART.md) - First steps
- [TUTORIAL.md](TUTORIAL.md) - Learning path

**Configuration:**
- [CONFIGURATION.md](CONFIGURATION.md) - Complete configuration guide
- [USAGE.md](USAGE.md) - Configuration examples

**Tools:**
- [TOOLS.md](TOOLS.md) - Built-in tools and custom creation
- [USAGE.md](USAGE.md) - Tool usage examples
- [API.md](API.md) - Tool API reference

**API Reference:**
- [API.md](API.md) - Complete API reference
- [QUICKREF.md](QUICKREF.md) - Common operations

**Architecture:**
- [ARCHITECTURE.md](ARCHITECTURE.md) - System design
- [FOLDER_STRUCTURE.md](FOLDER_STRUCTURE.md) - Code organization
- [PROJECT_OVERVIEW.md](PROJECT_OVERVIEW.md) - Project goals

**Advanced Features:**
- [ADVANCED.md](ADVANCED.md) - Forest of Agents, performance, security
- [RAG.md](RAG.md) - Vector search and retrieval
- [STREAMING.md](STREAMING.md) - Real-time responses
- [IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md) - Technical details

### Search by Use Case

**Building Agents:**
- [TUTORIAL.md](TUTORIAL.md) - Agent creation
- [USAGE.md](USAGE.md) - Agent patterns
- [API.md](API.md) - Agent API reference

**Using Tools:**
- [TOOLS.md](TOOLS.md) - Tool documentation
- [USAGE.md](USAGE.md) - Tool usage examples
- [TUTORIAL.md](TUTORIAL.md) - Tool integration

**Running Locally:**
- [CONFIGURATION.md](CONFIGURATION.md) - Local model setup
- [USAGE.md](USAGE.md) - Offline mode
- [ARCHITECTURE.md](ARCHITECTURE.md) - Local inference architecture

**Multi-Agent Systems:**
- [ADVANCED.md](ADVANCED.md) - Forest of Agents
- [USAGE.md](USAGE.md) - Multi-agent patterns

**RAG Applications:**
- [RAG.md](RAG.md) - RAG implementation
- [ADVANCED.md](ADVANCED.md) - Advanced RAG features

## 🤝 Contributing to Documentation

### Adding New Documentation
1. Choose the appropriate file or create a new one following the naming convention
2. Follow the existing documentation style and structure
3. Update this README to include the new document
4. Ensure cross-references are accurate

### Documentation Standards
- Use Markdown for all documentation
- Include code examples where relevant
- Provide both conceptual and practical information
- Keep documentation up-to-date with code changes
- Use clear, concise language accessible to different experience levels

### File Naming Convention
- Use UPPER_CASE for main documentation files
- Use descriptive names that clearly indicate content
- Use .md extension for all documentation files

## 📞 Support

If you can't find what you're looking for:
1. Check the main [README.md](../README.md) for a high-level overview
2. Look at the [examples](../examples/) directory for code samples
3. Check the [tests](../tests/) directory for implementation examples
4. Open an issue on GitHub for documentation improvements

## 🔗 Related Resources

- **[Main README](../README.md)** - Project overview and quick start
- **[Examples](../examples/)** - Code examples and use cases
- **[Tests](../tests/)** - Implementation examples and testing
- **[Source Code](../src/)** - Implementation details