PopUpSim Documentation

This directory contains all documentation for PopUpSim, organized by topic.

Documentation Structure

docs/
├── tutorial/              # Step-by-step configuration tutorial
├── mvp/                  # MVP implementation documentation
├── requirements/         # Requirements and use cases
├── adr/                  # Architecture Decision Records
├── ci-cd.md             # CI/CD pipeline documentation
├── DOCS_DEPLOYMENT.md   # Documentation deployment guide
└── DOCS_SETUP.md        # Documentation setup instructions

Quick Navigation

Getting Started

• Tutorial - Step-by-step configuration guide
• Installation Guide - Installing Python, uv, and PopUpSim

MVP Documentation

• MVP Architecture - Complete arc42 architecture for the MVP
• MVP Development Guide - Implementation details and examples

Requirements & Use Cases

• Use Cases - User stories and requirements
• Concept Document - Original concept

Architecture Decisions

• ADR Overview - Performance optimizations and architectural decisions

Architecture Overview

PopUpSim MVP uses a 3-context architecture:

Context	Purpose	Technology
Configuration	Input validation & parsing	Pydantic
Workshop Operations	Simulation execution	SimPy
Analysis & Reporting	Output generation	Matplotlib, CSV

Getting Started

1. For MVP Development: Start with MVP Architecture
2. For Requirements: Review Use Cases
3. For Architecture Decisions: Browse MVP ADRs

Contributing to Documentation

• Follow arc42 template for architecture documentation
• Keep documentation current with code changes
• Update cross-references when moving or renaming files

Documentation Maintenance

• Tutorial: Updated when configuration format changes
• MVP Documentation: Updated during development
• Cross-References: Maintained manually
• Navigation: Keep README files current with structure changes