Welcome to the Dantzig documentation. This directory contains comprehensive documentation for users, developers, and AI assistants.

Documentation for users of Dantzig:

• Quick Start - Get started quickly
• Tutorial - Step-by-step tutorials
• Reference - Complete syntax and API reference
• Guides - How-to guides and best practices

Documentation for developers contributing to Dantzig:

• Architecture - System architecture and design
• Code Structure - Module organization
• Data Structures - Core data structure reference
• Extension Points - How to extend Dantzig
• Contributing - Contribution guidelines

Documentation specifically for AI assistants:

• Codebase Overview - Project structure
• Key Concepts - Core concepts and patterns
• Module Map - Module responsibilities
• Extension Guide - Adding features
• Common Patterns - Code patterns
• Debugging Guide - Troubleshooting
• Decision Logging - Design decisions

Development notes, reports, and planning documents (for project maintainers):

• Development Notes - Fix summaries, refactoring plans
• Reports - Test reports, example status, phase summaries
• Planning - Planning documents

• Quick Start Guide - Install and run your first optimization problem
• DSL Syntax Reference - Complete syntax guide

• Architecture Overview - System design
• Extension Guide - Adding features
• Contributing Guide - Code style

• Codebase Overview - Project structure
• Module Map - Where to find functionality
• Key Concepts - Core concepts

The API reference is generated from code documentation using ExDoc. See the Developer Documentation for details.

Working examples are available in the Examples Directory:

• tutorial_examples.exs - Comprehensive tutorial examples
• knapsack_problem.exs - Knapsack problem
• diet_problem.exs - Diet problem
• transportation_problem.exs - Transportation problem
• And more...

See the Contributing Guide for documentation style guidelines and contribution instructions.