From b511e052e264214569445ecc9bcde0a033cfb8c5 Mon Sep 17 00:00:00 2001 From: Tobias Gesellchen Date: Sat, 14 Feb 2026 22:42:24 +0100 Subject: [PATCH] docs: fix broken documentation links and update CI workflow paths --- .github/workflows/ci.yml | 6 ++--- README.md | 28 +++++++++++----------- docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md | 16 ++++++------- examples/account-management/README.md | 2 +- examples/content-selection/README.md | 4 ++-- examples/introspect/README.md | 8 +++---- examples/navigation-station-demo/README.md | 8 +++---- examples/preset-management/README.md | 8 +++---- examples/recents/README.md | 10 ++++---- 9 files changed, 45 insertions(+), 45 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 14b9fcf..a7331a8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -149,8 +149,8 @@ jobs: # Check that all documented endpoints exist in code echo "Validating API documentation consistency..." - # Extract endpoint patterns from cookbook - if [ -f "docs/API-COOKBOOK.md" ]; then + # Check API cookbook + if [ -f "docs/reference/API-COOKBOOK.md" ]; then echo "βœ“ API Cookbook exists" else echo "βœ— API Cookbook missing" @@ -158,7 +158,7 @@ jobs: fi # Check getting started guide - if [ -f "docs/GETTING-STARTED.md" ]; then + if [ -f "docs/guides/GETTING-STARTED.md" ]; then echo "βœ“ Getting Started guide exists" else echo "βœ— Getting Started guide missing" diff --git a/README.md b/README.md index cca4b3d..701ba2a 100644 --- a/README.md +++ b/README.md @@ -379,19 +379,19 @@ This library supports all Bose SoundTouch-compatible devices, including: ## Documentation - πŸ“– [Contributing Guide](CONTRIBUTING.md) - How to contribute to the project -- πŸ“š [API Reference](docs/API-Endpoints-Overview.md) - Complete endpoint documentation -- πŸ”§ [CLI Reference](docs/CLI-REFERENCE.md) - Command-line tool guide -- 🌐 [SoundTouch Service Guide](docs/SOUNDTOUCH-SERVICE.md) - Local service setup and migration -- 🎯 [Getting Started](docs/GETTING-STARTED.md) - Detailed setup and usage +- πŸ“š [API Reference](docs/reference/API-ENDPOINTS.md) - Complete endpoint documentation +- πŸ”§ [CLI Reference](docs/guides/CLI-REFERENCE.md) - Command-line tool guide +- 🌐 [SoundTouch Service Guide](docs/guides/SOUNDTOUCH-SERVICE.md) - Local service setup and migration +- 🎯 [Getting Started](docs/guides/GETTING-STARTED.md) - Detailed setup and usage - πŸ“» [Preset Quick Start](docs/PRESET-QUICKSTART.md) - Favorite content management - 🧭 [Navigation Guide](docs/NAVIGATION-GUIDE.md) - Content browsing and station management - πŸ“‹ [Navigation API Reference](docs/API-NAVIGATION-REFERENCE.md) - Navigation API documentation -- βš™οΈ [Advanced Features](docs/SYSTEM-ENDPOINTS.md) - Advanced functionality -- 🏠 [Multiroom Setup](docs/zone-management.md) - Zone configuration guide -- ⚑ [WebSocket Events](docs/websocket-events.md) - Real-time event handling -- πŸ”” [Speaker Notifications](docs/SPEAKER_ENDPOINT.md) - TTS and audio notifications guide -- πŸ” [Device Discovery](docs/DISCOVERY.md) - Discovery configuration -- πŸ› οΈ [Troubleshooting](docs/TROUBLESHOOTING.md) - Common issues and solutions +- βš™οΈ [Advanced Features](docs/reference/SYSTEM-ENDPOINTS.md) - Advanced functionality +- 🏠 [Multiroom Setup](docs/reference/ZONE-MANAGEMENT.md) - Zone configuration guide +- ⚑ [WebSocket Events](docs/reference/WEBSOCKET-EVENTS.md) - Real-time event handling +- πŸ”” [Speaker Notifications](docs/reference/SPEAKER-ENDPOINT.md) - TTS and audio notifications guide +- πŸ” [Device Discovery](docs/reference/DISCOVERY.md) - Discovery configuration +- πŸ› οΈ [Troubleshooting](docs/guides/TROUBLESHOOTING.md) - Common issues and solutions ## Development @@ -528,11 +528,11 @@ If you discover new endpoints, features, or improvements through this library, p - ❓ **Questions**: Check [existing discussions](https://github.com/gesellix/bose-soundtouch/discussions) - πŸ“– **Documentation**: Browse the [docs/](docs/) directory - πŸ” **New Discoveries**: See [Undocumented Community Features](docs/UNDOCUMENTED-COMMUNITY-FEATURES.md) for advanced API research -- 🌐 **Upstream Analysis**: [Upstream URLs & Domains](docs/UPSTREAM-URLS-ANALYSIS.md) for cloud dependency research -- πŸ”§ **Redirection Guide**: [Device Redirect Methods](docs/DEVICE-REDIRECT-METHODS.md) for custom service setup -- 🐣 **Initial Setup**: [Device Initial Setup Variants](docs/DEVICE-INITIAL-SETUP.md) for out-of-the-box configuration +- 🌐 **Upstream Analysis**: [Upstream URLs & Domains](docs/analysis/UPSTREAM-URLS.md) for cloud dependency research +- πŸ”§ **Redirection Guide**: [Device Redirect Methods](docs/analysis/DEVICE-REDIRECT-METHODS.md) for custom service setup +- 🐣 **Initial Setup**: [Device Initial Setup Variants](docs/guides/DEVICE-INITIAL-SETUP.md) for out-of-the-box configuration - πŸ“œ **Logging & Debugging**: [Device Logging Guide](docs/DEVICE-LOGGING.md) for accessing system and traffic logs -- πŸ”’ **HTTPS & CA Setup**: [HTTPS & Custom CA Guide](docs/HTTPS-SETUP.md) for secure `/etc/hosts` redirection +- πŸ”’ **HTTPS & CA Setup**: [HTTPS & Custom CA Guide](docs/guides/HTTPS-SETUP.md) for secure `/etc/hosts` redirection --- diff --git a/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md b/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md index 6281732..b5c1885 100644 --- a/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md +++ b/docs/SOUNDTOUCH-SERVICE-ANNOUNCEMENT.md @@ -144,10 +144,10 @@ LOG_PROXY_BODY=true soundtouch-service ## πŸ“š Documentation -- **[Complete Service Guide](SOUNDTOUCH-SERVICE.md)**: Comprehensive setup and configuration -- **[API Reference](SOUNDTOUCH-SERVICE.md#api-reference)**: Full endpoint documentation -- **[Migration Guide](SOUNDTOUCH-SERVICE.md#device-migration)**: Step-by-step device migration -- **[Troubleshooting](SOUNDTOUCH-SERVICE.md#troubleshooting)**: Common issues and solutions +- **[Complete Service Guide](guides/SOUNDTOUCH-SERVICE.md)**: Comprehensive setup and configuration +- **[API Reference](guides/SOUNDTOUCH-SERVICE.md#api-reference)**: Full endpoint documentation +- **[Migration Guide](guides/SOUNDTOUCH-SERVICE.md#device-migration)**: Step-by-step device migration +- **[Troubleshooting](guides/SOUNDTOUCH-SERVICE.md#troubleshooting)**: Common issues and solutions ## 🀝 Contributing @@ -172,9 +172,9 @@ The collaborative spirit of reverse engineering and documentation in the SoundTo ## πŸ”— Links - **[Main Repository](https://github.com/gesellix/bose-soundtouch)** -- **[Service Documentation](SOUNDTOUCH-SERVICE.md)** -- **[CLI Documentation](CLI-REFERENCE.md)** -- **[Getting Started Guide](GETTING-STARTED.md)** +- **[Service Documentation](guides/SOUNDTOUCH-SERVICE.md)** +- **[CLI Documentation](guides/CLI-REFERENCE.md)** +- **[Getting Started Guide](guides/GETTING-STARTED.md)** - **[SoundCork Project](https://github.com/deborahgu/soundcork)** - **[ÜberBΓΆse API](https://github.com/julius-d/ueberboese-api)** @@ -187,4 +187,4 @@ go install github.com/gesellix/bose-soundtouch/cmd/soundtouch-service@latest soundtouch-service ``` -Open `http://localhost:8000` and start your journey to local SoundTouch control! 🎡 \ No newline at end of file +Open `http://localhost:8000` and start your journey to local SoundTouch control! 🎡 diff --git a/examples/account-management/README.md b/examples/account-management/README.md index 526cb5c..7700aa3 100644 --- a/examples/account-management/README.md +++ b/examples/account-management/README.md @@ -149,4 +149,4 @@ After configuring accounts: 3. Use `browse` commands to explore content 4. Use `play` commands to start playback -See the [CLI Reference](../../docs/CLI-REFERENCE.md) for complete documentation. \ No newline at end of file +See the [CLI Reference](../../docs/guides/CLI-REFERENCE.md) for complete documentation. diff --git a/examples/content-selection/README.md b/examples/content-selection/README.md index 541676f..ea46e70 100644 --- a/examples/content-selection/README.md +++ b/examples/content-selection/README.md @@ -176,5 +176,5 @@ The example gracefully handles missing services: ## Related Documentation - [SoundTouch WebServices API Wiki](https://github.com/thlucas1/homeassistantcomponent_soundtouchplus/wiki/SoundTouch-WebServices-API) -- [CLI Reference](../../docs/CLI-REFERENCE.md) -- [Navigation Guide](../../docs/NAVIGATION-GUIDE.md) \ No newline at end of file +- [CLI Reference](../../docs/guides/CLI-REFERENCE.md) +- [Navigation Guide](../../docs/guides/SURVIVAL-GUIDE.md) diff --git a/examples/introspect/README.md b/examples/introspect/README.md index 2255edc..4104fd7 100644 --- a/examples/introspect/README.md +++ b/examples/introspect/README.md @@ -177,11 +177,11 @@ if err != nil { This introspect data is useful before: - [Preset Management](../preset-management/) - Verify service state before storing presets -- [Content Selection](../../docs/SOURCE-SELECTION.md) - Check capabilities before switching sources -- [Zone Management](../../docs/zone-management.md) - Ensure all devices support the service +- [Content Selection](../../docs/reference/SOURCE-SELECTION.md) - Check capabilities before switching sources +- [Zone Management](../../docs/reference/ZONE-MANAGEMENT.md) - Ensure all devices support the service ## API Documentation For complete API documentation, see: -- [API Reference](../../docs/API-Endpoints-Overview.md) -- [Service Availability Implementation](../../docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md) \ No newline at end of file +- [API Reference](../../docs/reference/API-ENDPOINTS.md) +- [Service Availability Implementation](../../docs/SERVICE-AVAILABILITY-IMPLEMENTATION.md) diff --git a/examples/navigation-station-demo/README.md b/examples/navigation-station-demo/README.md index 596431d..8973a71 100644 --- a/examples/navigation-station-demo/README.md +++ b/examples/navigation-station-demo/README.md @@ -275,10 +275,10 @@ go run ./cmd/soundtouch-cli --host 192.168.1.100 info ## Related Documentation -- [CLI Reference](../../docs/CLI-REFERENCE.md) - Browse and station commands -- [Navigation Guide](../../docs/NAVIGATION-GUIDE.md) - Comprehensive navigation documentation +- [CLI Reference](../../docs/guides/CLI-REFERENCE.md) - Browse and station commands +- [Navigation Guide](../../docs/guides/SURVIVAL-GUIDE.md) - Comprehensive navigation documentation - [Navigation API Reference](../../docs/API-NAVIGATION-REFERENCE.md) - Technical API details -- [WebSocket Events](../../docs/websocket-events.md) - Real-time event handling +- [WebSocket Events](../../docs/reference/WEBSOCKET-EVENTS.md) - Real-time event handling ## Use Cases @@ -288,4 +288,4 @@ This example demonstrates patterns for: - **Direct Playback**: Play content without storing as presets first - **Content Exploration**: Browse large music libraries efficiently - **Smart Home Integration**: Programmatically start specific content -- **Personalized Experiences**: Access account-specific content from streaming services \ No newline at end of file +- **Personalized Experiences**: Access account-specific content from streaming services diff --git a/examples/preset-management/README.md b/examples/preset-management/README.md index d08aca2..5134598 100644 --- a/examples/preset-management/README.md +++ b/examples/preset-management/README.md @@ -256,10 +256,10 @@ Error: All preset slots are occupied ## Related Documentation -- [CLI Reference](../../docs/CLI-REFERENCE.md) - Command-line usage +- [CLI Reference](../../docs/guides/CLI-REFERENCE.md) - Command-line usage - [Preset Implementation Guide](../../docs/preset-store.md) - Technical details -- [WebSocket Events](../../docs/websocket-events.md) - Real-time event handling -- [API Reference](../../docs/API-Endpoints-Overview.md) - Complete API documentation +- [WebSocket Events](../../docs/reference/WEBSOCKET-EVENTS.md) - Real-time event handling +- [API Reference](../../docs/reference/API-ENDPOINTS.md) - Complete API documentation ## Use Cases @@ -269,4 +269,4 @@ This example demonstrates patterns for: - **Music Management**: Organize favorite content into quick-access presets - **Family Scenarios**: Each person gets their own preset slots - **Party Mode**: Pre-configure playlists for different moods -- **Radio Favorites**: Save frequently listened radio stations \ No newline at end of file +- **Radio Favorites**: Save frequently listened radio stations diff --git a/examples/recents/README.md b/examples/recents/README.md index f955c41..2f54081 100644 --- a/examples/recents/README.md +++ b/examples/recents/README.md @@ -252,8 +252,8 @@ go run main.go -host 192.168.1.100 -type unknown This recents data is useful for: - [Preset Management](../preset-management/) - Finding presetable content to save -- [Content Selection](../../docs/SOURCE-SELECTION.md) - Understanding usage patterns -- [Navigation](../../docs/NAVIGATION-GUIDE.md) - Quickly accessing recently played content +- [Content Selection](../../docs/reference/SOURCE-SELECTION.md) - Understanding usage patterns +- [Navigation](../../docs/guides/SURVIVAL-GUIDE.md) - Quickly accessing recently played content ## Related CLI Commands @@ -274,6 +274,6 @@ soundtouch-cli --host 192.168.1.100 recents latest ## API Documentation For complete API documentation, see: -- [API Reference](../../docs/API-Endpoints-Overview.md) -- [CLI Reference](../../docs/CLI-REFERENCE.md) -- [Recents Models](../../pkg/models/recents.go) \ No newline at end of file +- [API Reference](../../docs/reference/API-ENDPOINTS.md) +- [CLI Reference](../../docs/guides/CLI-REFERENCE.md) +- [Recents Models](../../pkg/models/recents.go)