Improve Documentation and Provide Usage Examples

[mpecan]

Description

Current documentation is limited. We need comprehensive documentation and examples to make the system easier to adopt.

Tasks

• Create comprehensive API documentation
• Write getting started guides
• Provide configuration examples for common scenarios
• Create example applications demonstrating different protocols
• Add deployment guides for various environments (Docker, Kubernetes, AWS)
• Document performance tuning recommendations

Acceptance Criteria

• Documentation covers all aspects of the system
• Examples demonstrate all supported protocols
• Deployment guides for at least 3 common environments
• Performance tuning section with recommendations

Technical Details

• Add Javadoc/KDoc to all public classes and methods
• Create a documentation site using a tool like Docusaurus or MkDocs
• Provide sample applications for each protocol:
  • WebSocket example
  • SSE example
  • HTTP long-polling example
  • Mixed protocol example
• Create example Docker Compose setups for different scenarios
• Write Kubernetes deployment manifests
• Create AWS CloudFormation/CDK templates
• Document performance characteristics and scaling guidelines