From 0c5c1803a5b1ceb8479a36d435d2ca987e3f18a9 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sat, 14 Feb 2026 23:00:47 +0100 Subject: [PATCH] docs: fix broken documentation links across multiple files --- CONTRIBUTING.md | 8 ++++---- docs/CLAUDE.md | 5 ++--- docs/CONTENT-SELECTION-IMPLEMENTATION.md | 7 ++++--- docs/PRESET-QUICKSTART.md | 10 +++++----- docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md | 4 ++-- docs/SUMMARY.md | 4 ++-- docs/guides/CLI-REFERENCE.md | 6 +++--- docs/reference/SOURCE-SELECTION.md | 10 +++++----- 8 files changed, 27 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bf23d4..8773edd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,7 +76,7 @@ When filing a bug report, include: Feature requests are welcome! Please: 1. **Check if the feature already exists** in documentation -2. **Verify it's supported by the SoundTouch API** (see [official API docs](docs/API-Endpoints-Overview.md)) +2. **Verify it's supported by the SoundTouch API** (see [official API docs](docs/reference/API-ENDPOINTS.md)) 3. **Explain the use case** and how it benefits users ### 🔧 Contributing Code @@ -469,10 +469,10 @@ Contributors will be: - [Go Documentation](https://golang.org/doc/) - [Effective Go](https://golang.org/doc/effective_go.html) -- [Bose SoundTouch API Documentation](docs/API-Endpoints-Overview.md) +- [Bose SoundTouch API Documentation](docs/reference/API-ENDPOINTS.md) - [Project Architecture](docs/PROJECT-PATTERNS.md) -- [Development Status](docs/STATUS.md) +- [Development Status](docs/archive/STATUS.md) --- -**Thank you for contributing!** Every contribution helps make this library better for the entire SoundTouch community. \ No newline at end of file +**Thank you for contributing!** Every contribution helps make this library better for the entire SoundTouch community. diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md index d6c71e1..e069f8e 100644 --- a/docs/CLAUDE.md +++ b/docs/CLAUDE.md @@ -4,9 +4,9 @@ This document contains important development guidelines for working on the Bose SoundTouch project. Please also read the following documentation: -- **[PLAN.md](PLAN.md)** - Project planning and roadmap +- **[PLAN.md](archive/PLAN.md)** - Project planning and roadmap - **[PROJECT-PATTERNS.md](PROJECT-PATTERNS.md)** - Project structure and design patterns -- **[API-Endpoints-Overview.md](API-Endpoints-Overview.md)** - API endpoints overview +- **[API-ENDPOINTS.md](reference/API-ENDPOINTS.md)** - API endpoints overview - **[SoundTouch Web API.pdf](2025.12.18%20SoundTouch%20Web%20API.pdf)** - Official API documentation ## Development Guidelines @@ -95,4 +95,3 @@ When creating test data for API endpoints, prefer real device responses over hyp - **Documentation**: Completely in English for international accessibility - Conduct regular code reviews - Consider performance from the beginning - diff --git a/docs/CONTENT-SELECTION-IMPLEMENTATION.md b/docs/CONTENT-SELECTION-IMPLEMENTATION.md index f23276d..a6e0155 100644 --- a/docs/CONTENT-SELECTION-IMPLEMENTATION.md +++ b/docs/CONTENT-SELECTION-IMPLEMENTATION.md @@ -195,8 +195,9 @@ soundtouch-cli --host 192.168.1.100 source internet-radio \ - [SoundTouch WebServices API Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) - [LOCAL_INTERNET_RADIO - streamUrl format](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API#select-local_internet_radio---streamurl-format) - [LOCAL_MUSIC](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API#select-local_music) -- [Content Selection Example](/examples/content-selection/) -- [CLI Reference](/docs/CLI-REFERENCE.md) +- [Content Selection Example](../examples/content-selection/README.md) +- [CLI Reference](guides/CLI-REFERENCE.md) +- [Content Selection Example (Direct)](../examples/content-selection/) ## ✅ Verification @@ -208,4 +209,4 @@ This implementation has been verified to: 5. ✅ Include complete documentation and examples 6. ✅ Maintain backward compatibility -**Status**: 🎉 **COMPLETE** - All requested content selection features are fully implemented and ready for use! \ No newline at end of file +**Status**: 🎉 **COMPLETE** - All requested content selection features are fully implemented and ready for use! diff --git a/docs/PRESET-QUICKSTART.md b/docs/PRESET-QUICKSTART.md index c94fbd3..387a3f7 100644 --- a/docs/PRESET-QUICKSTART.md +++ b/docs/PRESET-QUICKSTART.md @@ -332,14 +332,14 @@ soundtouch-cli --host 192.168.1.100 info ## Next Steps -- 📖 [Complete CLI Reference](CLI-REFERENCE.md) -- 🔧 [Full Implementation Guide](preset-store.md) -- 📡 [WebSocket Events Documentation](websocket-events.md) +- 📖 [Complete CLI Reference](guides/CLI-REFERENCE.md) +- 🔧 [Full Implementation Guide](reference/PRESET-MANAGEMENT.md) +- 📡 [WebSocket Events Documentation](reference/WEBSOCKET-EVENTS.md) - 💻 [Preset Management Example](../examples/preset-management/) -- 📚 [API Endpoints Overview](API-Endpoints-Overview.md) +- 📚 [API Endpoints Overview](reference/API-ENDPOINTS.md) ## Need Help? - 🐛 **Bug Reports**: [Create an issue](https://github.com/gesellix/bose-soundtouch/issues) - 💡 **Feature Requests**: [Start a discussion](https://github.com/gesellix/bose-soundtouch/discussions) -- ❓ **Questions**: [Browse discussions](https://github.com/gesellix/bose-soundtouch/discussions) \ No newline at end of file +- ❓ **Questions**: [Browse discussions](https://github.com/gesellix/bose-soundtouch/discussions) diff --git a/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md b/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md index e2f79b3..c431ec6 100644 --- a/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md +++ b/docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md @@ -23,7 +23,7 @@ This document summarizes the implementation of the `/serviceAvailability` endpoi ### Modified Files 1. **`pkg/client/client.go`** - Added `GetServiceAvailability()` method -2. **`docs/API-Endpoints-Overview.md`** - Updated implementation status +2. **`docs/reference/API-ENDPOINTS.md`** - Updated implementation status 3. **`docs/UNIMPLEMENTED-ENDPOINTS.md`** - Marked as implemented ## API Interface @@ -263,4 +263,4 @@ BenchmarkGetServiceAvailability-8 1000 1.2ms/op ✅ **Performance benchmarks established** ✅ **Error handling verified** -The ServiceAvailability implementation is production-ready and provides a solid foundation for building user-friendly SoundTouch applications with better service discovery and user feedback capabilities. \ No newline at end of file +The ServiceAvailability implementation is production-ready and provides a solid foundation for building user-friendly SoundTouch applications with better service discovery and user feedback capabilities. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index a2daa51..6dd1d59 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -15,8 +15,8 @@ ### Useful Links * [Cloud Shutdown Survival Guide](guides/SURVIVAL-GUIDE.md) -* [Raspberry Pi Installer](../../scripts/raspberry-pi/README.md) -* [Updating the Service](../../scripts/raspberry-pi/README.md#updating-to-a-new-version) +* [Raspberry Pi Installer](../scripts/raspberry-pi/README.md) +* [Updating the Service](../scripts/raspberry-pi/README.md#updating-to-a-new-version) * [CLI Reference](guides/CLI-REFERENCE.md) ## Technical Reference diff --git a/docs/guides/CLI-REFERENCE.md b/docs/guides/CLI-REFERENCE.md index 1a7cc28..bf3f26d 100644 --- a/docs/guides/CLI-REFERENCE.md +++ b/docs/guides/CLI-REFERENCE.md @@ -1248,6 +1248,6 @@ SOUNDTOUCH_DISCOVERY_TIMEOUT=10s ## See Also - [Getting Started Guide](GETTING-STARTED.md) - Basic setup and usage -- [WebSocket Events](websocket-events.md) - Real-time monitoring -- [Zone Management](zone-management.md) - Multi-room setup -- [API Endpoints](API-Endpoints-Overview.md) - Complete API reference +- [WebSocket Events](../reference/WEBSOCKET-EVENTS.md) - Real-time monitoring +- [Zone Management](../reference/ZONE-MANAGEMENT.md) - Multi-room setup +- [API Endpoints](../reference/API-ENDPOINTS.md) - Complete API reference diff --git a/docs/reference/SOURCE-SELECTION.md b/docs/reference/SOURCE-SELECTION.md index 0cfc5ea..8090a83 100644 --- a/docs/reference/SOURCE-SELECTION.md +++ b/docs/reference/SOURCE-SELECTION.md @@ -345,13 +345,13 @@ The implementation follows the official SoundTouch API: ## Related Documentation -- **[API Endpoints Overview](API-Endpoints-Overview.md)** - Complete API reference -- **[Sources](../pkg/models/sources.go)** - Source model implementation -- **[Now Playing](../pkg/models/nowplaying.go)** - ContentItem model -- **[Client Usage Examples](../cmd/soundtouch-cli/main.go)** - CLI implementation reference +- **[API Endpoints Overview](API-ENDPOINTS.md)** - Complete API reference +- **[Sources](../../pkg/models/sources.go)** - Source model implementation +- **[Now Playing](../../pkg/models/nowplaying.go)** - ContentItem model +- **[Client Usage Examples](../../cmd/soundtouch-cli/main.go)** - CLI implementation reference --- **Implementation Date**: 2026-01-09 **Status**: ✅ Complete and tested -**Real Device Validation**: SoundTouch 10, SoundTouch 20 \ No newline at end of file +**Real Device Validation**: SoundTouch 10, SoundTouch 20