> For the complete documentation index, see [llms.txt](https://sarpers-organization.gitbook.io/omnitask/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sarpers-organization.gitbook.io/omnitask/readme.md).

# README

Welcome to the comprehensive documentation for OmniTask, the pure Python workflow automation engine.

## Table of Contents

### Getting Started

* [Installation & Setup](https://sarpers-organization.gitbook.io/omnitask/getting-started/installation)
* [Quick Start Guide](https://sarpers-organization.gitbook.io/omnitask/getting-started/quick-start)
* [Basic Concepts](https://sarpers-organization.gitbook.io/omnitask/getting-started/concepts)

### User Guide

* [Creating Tasks](https://sarpers-organization.gitbook.io/omnitask/user-guide/creating-tasks)
* [Building Workflows](https://sarpers-organization.gitbook.io/omnitask/user-guide/building-workflows)
* [YAML Configuration](https://sarpers-organization.gitbook.io/omnitask/user-guide/yaml-configuration)
* [Dependency Management](https://sarpers-organization.gitbook.io/omnitask/user-guide/dependency-management)
* [Task Groups](https://sarpers-organization.gitbook.io/omnitask/user-guide/task-groups)
* [Streaming Tasks](https://sarpers-organization.gitbook.io/omnitask/user-guide/streaming-tasks)
* [Conditional Execution](https://sarpers-organization.gitbook.io/omnitask/user-guide/conditional-execution)
* [Progress Tracking](https://sarpers-organization.gitbook.io/omnitask/user-guide/progress-tracking)
* [Error Handling](https://sarpers-organization.gitbook.io/omnitask/user-guide/error-handling)
* [Caching](https://sarpers-organization.gitbook.io/omnitask/user-guide/caching)

### API Reference

* [Core Classes](https://sarpers-organization.gitbook.io/omnitask/api-reference/core)
* [Task System](https://sarpers-organization.gitbook.io/omnitask/api-reference/task-system)
* [Workflow Management](https://sarpers-organization.gitbook.io/omnitask/api-reference/workflow-management)
* [Caching System](https://sarpers-organization.gitbook.io/omnitask/api-reference/caching-system)
* [Models & Data Structures](https://sarpers-organization.gitbook.io/omnitask/api-reference/models)

### Architecture

* [System Overview](https://sarpers-organization.gitbook.io/omnitask/architecture/overview)
* [Core Engine](https://sarpers-organization.gitbook.io/omnitask/architecture/core-engine)
* [Task Execution](https://sarpers-organization.gitbook.io/omnitask/architecture/task-execution)
* [Dependency Resolution](https://sarpers-organization.gitbook.io/omnitask/architecture/dependency-resolution)
* [Streaming Architecture](https://sarpers-organization.gitbook.io/omnitask/architecture/streaming-architecture)
* [Caching System](https://sarpers-organization.gitbook.io/omnitask/architecture/caching-system)
* [Validation System](https://sarpers-organization.gitbook.io/omnitask/architecture/validation-system)

### Examples

* [Basic Examples](https://sarpers-organization.gitbook.io/omnitask/examples/basic-examples)
* [Streaming Examples](https://sarpers-organization.gitbook.io/omnitask/examples/streaming-examples)
* [Conditional Workflows](https://sarpers-organization.gitbook.io/omnitask/examples/conditional-workflows)
* [Caching Examples](https://sarpers-organization.gitbook.io/omnitask/examples/caching-examples)
* [Advanced Use Cases](https://sarpers-organization.gitbook.io/omnitask/examples/advanced-use-cases)

### Developer Guide

* [Extending OmniTask](https://sarpers-organization.gitbook.io/omnitask/developer-guide/extending-omnitask)
* [Creating Custom Tasks](https://sarpers-organization.gitbook.io/omnitask/developer-guide/custom-tasks)
* [Custom Cache Backends](https://sarpers-organization.gitbook.io/omnitask/developer-guide/custom-cache-backends)
* [Testing Strategies](https://sarpers-organization.gitbook.io/omnitask/developer-guide/testing-strategies)
* [Performance Optimization](https://sarpers-organization.gitbook.io/omnitask/developer-guide/performance-optimization)
* [Troubleshooting](https://sarpers-organization.gitbook.io/omnitask/developer-guide/troubleshooting)

## Quick Navigation

### Common Tasks

* [How to create a basic task](https://sarpers-organization.gitbook.io/omnitask/user-guide/creating-tasks#basic-task-creation)
* [How to set up dependencies](https://sarpers-organization.gitbook.io/omnitask/user-guide/dependency-management#setting-up-dependencies)
* [How to use streaming tasks](https://sarpers-organization.gitbook.io/omnitask/user-guide/streaming-tasks#creating-streaming-tasks)
* [How to enable caching](https://sarpers-organization.gitbook.io/omnitask/user-guide/caching#enabling-caching)
* [How to handle errors](https://sarpers-organization.gitbook.io/omnitask/user-guide/error-handling#error-handling-strategies)

### API Quick Reference

* [Workflow class](https://sarpers-organization.gitbook.io/omnitask/api-reference/workflow-management#workflow-class)
* [Task class](https://sarpers-organization.gitbook.io/omnitask/api-reference/task-system#task-class)
* [TaskResult class](https://sarpers-organization.gitbook.io/omnitask/api-reference/models#taskresult-class)
* [TaskRegistry class](https://sarpers-organization.gitbook.io/omnitask/api-reference/core#taskregistry-class)

### Examples by Use Case

* [Data Processing Pipeline](https://sarpers-organization.gitbook.io/omnitask/examples/basic-examples#data-processing-pipeline)
* [Real-time Data Streaming](https://sarpers-organization.gitbook.io/omnitask/examples/streaming-examples#real-time-data-streaming)
* [Conditional Workflows](https://sarpers-organization.gitbook.io/omnitask/examples/conditional-workflows#conditional-execution)
* [High-Performance Computing](https://sarpers-organization.gitbook.io/omnitask/examples/advanced-use-cases#high-performance-computing)

## Support

If you need help with OmniTask:

* Check the [Troubleshooting Guide](https://sarpers-organization.gitbook.io/omnitask/developer-guide/troubleshooting)
* Browse the [Examples](https://sarpers-organization.gitbook.io/omnitask/examples/) section
* Open an issue on [GitHub](https://github.com/sarperavci/omniTask/issues)

## Documentation Format

This documentation is written in Markdown and follows the GitHub Book format. Each section is self-contained and includes:

* Clear explanations with code examples
* Practical usage scenarios
* Best practices and tips
* Troubleshooting information
* Cross-references to related topics