# Klovis Documentation

Welcome to the Klovis documentation. This comprehensive guide will help you understand and use Klovis effectively for building document processing pipelines.

## 📚 Documentation Structure

### Getting Started
- [Installation Guide](installation.md) - Install and configure Klovis
- [Quick Start Guide](quickstart.md) - Get up and running in minutes
- [Core Concepts](concepts.md) - Understand Klovis architecture and design

### User Guides
- [Loaders Guide](guides/loaders.md) - Loading documents from various sources
- [Cleaning Guide](guides/cleaning.md) - Text cleaning and normalization
- [Chunking Guide](guides/chunking.md) - Document chunking strategies
- [Merging Guide](guides/merging.md) - Semantic chunk merging
- [Metadata Guide](guides/metadata.md) - Generating and managing metadata
- [Transformation Guide](guides/transformation.md) - Output formatting
- [Pipeline Guide](guides/pipeline.md) - Using KlovisPipeline

### API Reference
- [Loaders API](api/loaders.md) - Complete loader API documentation
- [Cleaners API](api/cleaners.md) - Complete cleaner API documentation
- [Chunkers API](api/chunkers.md) - Complete chunker API documentation
- [Mergers API](api/mergers.md) - Complete merger API documentation
- [Metadata API](api/metadata.md) - Complete metadata API documentation
- [Transformers API](api/transformers.md) - Complete transformer API documentation
- [Pipeline API](api/pipeline.md) - Complete pipeline API documentation
- [Models API](api/models.md) - Data models and structures

### Advanced Topics
- [Custom Components](advanced/custom-components.md) - Creating custom loaders, cleaners, etc.
- [Performance Optimization](advanced/performance.md) - Optimizing pipeline performance
- [Error Handling](advanced/error-handling.md) - Best practices for error handling
- [Integration Examples](advanced/integrations.md) - Integrating with other tools

### Examples & Tutorials
- [Basic Examples](examples/basic-examples.md) - Simple usage examples
- [Advanced Examples](examples/advanced-examples.md) - Complex use cases
- [RAG Pipeline Tutorial](examples/rag-pipeline.md) - Building a complete RAG pipeline

### Reference
- [Configuration](reference/configuration.md) - Configuration options
- [Exceptions](reference/exceptions.md) - Exception reference
- [Utilities](reference/utilities.md) - Utility functions and helpers

## 🚀 Quick Navigation

**New to Klovis?** Start with:
1. [Installation Guide](installation.md)
2. [Quick Start Guide](quickstart.md)
3. [Core Concepts](concepts.md)

**Looking for specific functionality?**
- Need to load documents? → [Loaders Guide](guides/loaders.md)
- Need to clean text? → [Cleaning Guide](guides/cleaning.md)
- Need to chunk documents? → [Chunking Guide](guides/chunking.md)
- Need to merge chunks? → [Merging Guide](guides/merging.md)
- Want to use the pipeline? → [Pipeline Guide](guides/pipeline.md)

**Building something complex?**
- [Custom Components](advanced/custom-components.md)
- [Advanced Examples](examples/advanced-examples.md)
- [RAG Pipeline Tutorial](examples/rag-pipeline.md)

## 📖 Documentation Conventions

- **Code blocks** show executable examples
- **Parameters** are documented with types and descriptions
- **Examples** are tested and working
- **Best practices** are highlighted with 💡 tips

## 🤝 Contributing to Documentation

Found an error or want to improve the documentation? Contributions are welcome! Please see the main repository's contributing guidelines.

