# RunNX Documentation
Welcome to the RunNX documentation! This directory contains comprehensive guides, API references, and development resources for the RunNX ONNX runtime.
## 📚 Documentation Structure
### 🚀 User Guides
- **[Quick Start Guide](guides/quick-start.md)** - Get up and running with RunNX in minutes
- **[Installation Guide](guides/installation.md)** - Detailed installation instructions for all platforms
- **[Usage Examples](guides/examples.md)** - Comprehensive examples and tutorials including YOLOv8
- **[Graph Visualization Guide](guides/graph-visualization.md)** - Complete guide to model visualization
- **[Format Compatibility Guide](FORMAT_COMPATIBILITY.md)** - JSON vs ONNX binary format support
- **[Command Line Interface](guides/cli.md)** - Complete CLI reference and tools
### � Development
- **[Contributing Guide](../CONTRIBUTING.md)** - How to contribute to RunNX
- **[Development Setup](development/setup.md)** - Complete environment setup for developers
- **[Quality Assurance](DEVELOPMENT_QA.md)** - Code quality tools and processes
- **[Formal Verification](../FORMAL_VERIFICATION.md)** - Mathematical verification system
### � Reference
- **[Changelog](../CHANGELOG.md)** - Complete version history with latest improvements
- **[Current Release Notes](../RELEASE_NOTES_0.2.0.md)** - Latest release information
- **[Release Archive](releases/)** - Historical release notes
- **[API Documentation](https://docs.rs/runnx)** - Complete API reference on docs.rs
## 🎯 Quick Navigation
### For New Users
1. **Start Here**: [Quick Start Guide](guides/quick-start.md) - Get running in under 5 minutes
2. **Install**: [Installation Guide](guides/installation.md) - Platform-specific setup
3. **Try Examples**: [Usage Examples](guides/examples.md) - YOLOv8 and more
### For Computer Vision Users
1. **Model Support**: Wide range of vision models (classification, detection, segmentation)
2. **Examples Available**: Object detection (YOLOv8), image classification, and more
3. **Try Examples**: `cargo run --example yolov8_detect_and_draw` for object detection
### For Developers
1. **Contribute**: [Contributing Guide](../CONTRIBUTING.md) - How to get involved
2. **Setup**: [Development Environment](development/setup.md) - Tools and workflow
3. **Quality**: [Quality Assurance](DEVELOPMENT_QA.md) - Standards and tools
### For Advanced Users
1. **Visualization**: [Graph Visualization](guides/graph-visualization.md) - Model inspection
2. **Verification**: [Formal Verification](../FORMAL_VERIFICATION.md) - Mathematical proofs
3. **Performance**: Benchmarking and optimization guides
## 🌟 What's New
### Latest Features (v0.2.0+)
- ✅ **Enhanced Model Support**: Comprehensive operator coverage for various model types
- ✅ **Computer Vision**: Full support for classification, detection, and segmentation models
- ✅ **Graph Visualization**: Professional diagrams and terminal visualization
- ✅ **Documentation**: Comprehensive guides and examples
## 🔍 Finding Information
- **Search by topic**: Use the structure above to find documentation by category
- **Browse examples**: Check the [examples/](../examples/) directory for working code
- **API documentation**: Run `cargo doc --open` for detailed API docs
- **Issues and questions**: Visit our [GitHub Issues](https://github.com/jgalego/runnx/issues)
## 📝 Documentation Standards
Our documentation follows these principles:
- **Clarity**: Written for both beginners and experts
- **Completeness**: Comprehensive coverage of all features
- **Accuracy**: Regularly updated and tested examples
- **Accessibility**: Easy to navigate and search
## 🤝 Contributing to Documentation
Found an issue or want to improve the docs? See our [Contributing Guide](../CONTRIBUTING.md) for:
- Documentation standards and style guide
- How to submit documentation improvements
- Testing documentation changes
---
**Need help?** Visit our [GitHub repository](https://github.com/jgalego/runnx) or [create an issue](https://github.com/jgalego/runnx/issues/new).