Commit Graph
3 Commits
Author SHA1 Message Date
Tobias Gesellchen ce4ec02468 fix: repair broken anchor links in API-COOKBOOK.md
- Simplify section headers to use standard markdown format
- Remove complex emojis and special characters that break anchor generation
- Update table of contents links to match simplified headers
- Fix 'Volume & Audio' section title with ampersand that caused encoding issues
- All internal links now work properly with GitHub's automatic anchor generation

Resolves failing CI documentation check
2026-01-10 12:24:51 +01:00
Tobias Gesellchen ccd19d97a5 docs: add attribution to official Bose SoundTouch Web API documentation
- Reference original API documentation source from Bose Corporation
- Link to official Bose SoundTouch End-of-Life page
- Clarify this is an independent implementation
- Add disclaimer about non-affiliation with Bose Corporation
- Provide both online and local documentation references
2026-01-10 00:34:54 +01:00
Tobias Gesellchen 01abf2d51f Add comprehensive documentation and polish
Major documentation additions:
- GETTING-STARTED.md: Complete 10-minute tutorial from discovery to WebSocket monitoring
- API-COOKBOOK.md: 1000+ lines of real-world patterns, recipes, and best practices
- TROUBLESHOOTING.md: Systematic guide for diagnosing and fixing common issues
- DEPLOYMENT.md: Production-ready deployment patterns and operational guidance

Key highlights:
- Step-by-step examples with working code
- Error handling and resilience patterns
- Performance optimization strategies
- Security and monitoring best practices
- Docker, Kubernetes, and systemd deployment examples
- Complete troubleshooting checklist with diagnostic commands
- Production-ready configuration management

This represents a significant investment in developer experience and makes the
SoundTouch Go client accessible to developers of all experience levels.
2026-01-09 12:58:35 +01:00