Create comprehensive API documentation with examples

[eraschle]

📚 Documentation Requirements

Create comprehensive API documentation covering all public interfaces with practical examples.

📋 Documentation Scope

1. Core Components

   • GenericElement usage patterns
   • HybridParameterInterface configuration
   • ParameterRegistry setup and usage
   • ElementRepository operations

2. Application Layer

   • Railway element creation and usage
   • Parameter access patterns (ENUM vs string)
   • Unit conversion examples
   • Container extension usage

3. Advanced Features

   • Custom element type creation
   • Plugin development guide
   • Performance optimization tips
   • Error handling best practices

🎯 Documentation Format

• API Reference: Docstring-based with Sphinx/mkdocs
• User Guide: Practical examples and tutorials
• Developer Guide: Extension and plugin development
• Migration Guide: From older versions

📝 Required Sections

API Reference

```python

Core Elements

from pymcore import GenericElement, ElementRepository
from pymapp import Pole, Foundation, Track

Create and configure elements

pole = Pole("pole_001")
pole.set_height(12.0, Unit.METER) # Auto-converts to mm
pole.set_material("steel")

Repository operations

repo = ElementRepository()
repo.save(pole.get_core_element())
loaded_pole = repo.get_by_id("pole_001")
```

Integration Examples

• Complete railway scene setup
• Multi-element relationships
• Parameter validation patterns
• Error handling examples

✅ Acceptance Criteria

• All public APIs documented with docstrings
• Practical examples for common use cases
• Migration guide from previous versions
• Performance considerations documented
• Error handling patterns explained
• Integration examples provided
• Documentation builds without warnings
• Examples tested and verified

📂 Documentation Structure

```
docs/
├── api/ # Auto-generated API reference
├── guides/ # User and developer guides
├── examples/ # Code examples and tutorials
├── migration/ # Version migration guides
└── contributing/ # Development guidelines
```

⏱️ Estimated Effort

3-4 days - Comprehensive documentation with examples and testing