# OrderBook-rs Documentation

Welcome to the OrderBook-rs documentation directory.

## Available Documentation

### 📘 [User Guide](USER_GUIDE.md)
Complete guide for using OrderBook-rs in your trading systems.

**Contents:**
- Installation and Quick Start
- Core concepts and basic operations
- Advanced features (market metrics, impact simulation, etc.)
- Performance optimization techniques
- Best practices and examples
- Troubleshooting guide

**Target audience:** Developers implementing trading systems

---

## Quick Links

- **[Main README](../README.md)**: Project overview and performance analysis
- **[Examples](../examples/README.md)**: 19 comprehensive examples
- **[API Documentation](https://docs.rs/orderbook-rs)**: Detailed API reference
- **[GitHub Repository](https://github.com/joaquinbejar/OrderBook-rs)**: Source code and issues

---

## Documentation Structure

```
doc/
├── README.md           # This file - documentation index
└── USER_GUIDE.md       # Complete user guide
```

---

## Getting Help

**For questions and support:**
- Read the [User Guide](USER_GUIDE.md) first
- Check the [Examples](../examples/README.md)
- Review the [API Documentation](https://docs.rs/orderbook-rs)
- Open an issue on [GitHub](https://github.com/joaquinbejar/OrderBook-rs/issues)

**For bugs or feature requests:**
- Open an issue on [GitHub](https://github.com/joaquinbejar/OrderBook-rs/issues)

---

## Contributing

Contributions are welcome! See our [GitHub repository](https://github.com/joaquinbejar/OrderBook-rs) for contribution guidelines.

---

**License:** MIT  
**Maintainer:** Joaquin Bejar (jb@taunais.com)
