# whirr Documentation

Welcome to the whirr documentation.

## Contents

- **[Getting Started](getting-started.md)** - Installation and first steps
- **[CLI Reference](cli-reference.md)** - All commands and options
- **[Python API](python-api.md)** - Library reference and examples
- **[Architecture](architecture.md)** - How whirr works under the hood

## Quick Links

### I want to...

| Goal | See |
|------|-----|
| Install whirr | [Getting Started](getting-started.md#installation) |
| Run my first experiment | [Getting Started](getting-started.md#quick-start) |
| Add tracking to my script | [Python API](python-api.md#quick-example) |
| Understand the CLI | [CLI Reference](cli-reference.md) |
| Run multiple GPU workers | [CLI Reference - worker](cli-reference.md#whirr-worker) |
| Understand how it works | [Architecture](architecture.md) |
| Contribute | [CONTRIBUTING.md](../CONTRIBUTING.md) |

## Getting Help

- [GitHub Issues](https://github.com/syntropy-systems-oss/whirr/issues) - Bug reports and feature requests
