maurocarlu's picture
add comprehensive project documentation including milestone summaries, a user guide, and design choices, and update the main README.
bba28e5
# Documentation
This directory contains comprehensive documentation for the Hopcroft Skill Classification system.
## Contents
| Document | Description |
|----------|-------------|
| [Milestone Summaries](milestone_summaries.md) | Overview of all 6 project development phases |
| [User Guide](user_guide.md) | Setup, API, GUI, load testing, and monitoring instructions |
| [Design Choices](design_choices.md) | Technical justifications and architectural decisions |
| [ML Canvas](ML%20Canvas.md) | Machine Learning Canvas requirements framework |
| [Testing & Validation](testing_and_validation.md) | QA strategy with test results and commands |
## Quick Links
- **Getting Started**: See [User Guide - System Setup](user_guide.md#1-system-setup)
- **API Reference**: See [User Guide - API Usage](user_guide.md#2-api-usage)
- **Architecture**: See [Design Choices](design_choices.md)
- **Project History**: See [Milestone Summaries](milestone_summaries.md)
## Images
The `img/` directory contains screenshots for GUI documentation.