Update and run the generate docs commands for my devices!#53
Open
BookCatKid wants to merge 3 commits into
Open
Update and run the generate docs commands for my devices!#53BookCatKid wants to merge 3 commits into
BookCatKid wants to merge 3 commits into
Conversation
✅ Deploy Preview for sonos-upnp ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Updates the Sonos discovery snapshots used by the @svrooij/sonos-docs generator and refreshes the generated service documentation pages, including adding a new discovery JSON for a Sonos Move (S17) device.
Changes:
- Updated discovery metadata (software version + discovery date) and service definitions for existing models (S1, S6, S9).
- Added a new discovery snapshot for
Sonos Move (S17)(software gen 2). - Regenerated multiple
docs/services/*.mdoutputs (primarily device/version tables, plus a new DeviceProperties event variable).
Reviewed changes
Copilot reviewed 20 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| generator/sonos-docs/data/sonos-S9-2.json | Updates Playbar (S9) discovery metadata and adjusts a DeviceProperties variable (WirelessLeafOnly -> ConnectionType). |
| generator/sonos-docs/data/sonos-S6-2.json | Updates Play:5 (S6) discovery metadata and multiple service details (notably AudioIn and DeviceProperties changes). |
| generator/sonos-docs/data/sonos-S17-2.json | Adds new discovery snapshot for Sonos Move (S17). |
| generator/sonos-docs/data/sonos-S1-2.json | Updates Play:1 (S1) discovery metadata and adjusts a DeviceProperties variable (WirelessLeafOnly -> ConnectionType). |
| docs/services/index.md | Updates device/version table in the services index. |
| docs/services/alarm-clock.md | Updates device/version table. |
| docs/services/audio-in.md | Updates device/version table for AudioIn-capable devices. |
| docs/services/av-transport.md | Updates device/version table. |
| docs/services/connection-manager.md | Updates device/version table. |
| docs/services/content-directory.md | Updates device/version table. |
| docs/services/device-properties.md | Adds ConnectionType to event variables and updates device/version table. |
| docs/services/group-management.md | Updates device/version table. |
| docs/services/group-rendering-control.md | Updates device/version table. |
| docs/services/ht-control.md | Updates device/version table. |
| docs/services/music-services.md | Updates device/version table. |
| docs/services/q-play.md | Updates device/version table. |
| docs/services/queue.md | Updates device/version table. |
| docs/services/rendering-control.md | Updates device/version table. |
| docs/services/system-properties.md | Updates device/version table. |
| docs/services/virtual-line-in.md | Updates device/version table. |
| docs/services/zone-group-topology.md | Updates device/version table. |
Comments suppressed due to low confidence (2)
docs/services/device-properties.md:669
- This generated DeviceProperties page’s device list does not include
Sonos Move (S17), even thoughsonos-S17-2.jsonwas added and includes the DeviceProperties service. This suggests the docs were regenerated without includingS17-2in thecombineinput models. Regenerate the service docs with S17 included so this table (and others) reflect the new device.
| Device | Software generation | Software version | Discovery date |
|:-------|:--------------------|:-----------------|:---------------|
| `Sonos Play:1 (S1)` | S2 | 86.4-73290 | 2026-02-09T06:10:23.572Z |
| `Sonos One (S13)` | S2 | 63.2-90210 | 2021-07-21T23:31:19.273Z |
| `Sonos Beam (S14)` | S2 | 64.3-19080 | 2021-08-18T06:04:08.308Z |
| `Sonos Amp (S16)` | S2 | 79.1-53290 | 2024-11-09T18:45:16.539Z |
| `Sonos One (S18)` | S2 | 85.0-64200 | 2026-01-11T22:43:37.357Z |
docs/services/audio-in.md:212
- For model
Sonos Play:5 (S6), the updated discovery JSON changes the AudioIn action signature:StartTransmissionToGroupnow takes an additionalObjectIDinput andSelectAudiowas removed. This generated page still documentsStartTransmissionToGroupwith onlyCoordinatorID(and includesSelectAudio), so it’s now inaccurate for S6. Regenerate the service docs in a way that captures per-model action signature differences (or at least includes the superset of inputs) so the published docs match the updated discovery data.
| Device | Software generation | Software version | Discovery date |
|:-------|:--------------------|:-----------------|:---------------|
| `Sonos Amp (S16)` | S2 | 79.1-53290 | 2024-11-09T18:45:16.539Z |
| `Sonos Era 100 (S39)` | S2 | 79.1-53290 | 2024-11-09T18:45:10.792Z |
| `Sonos Play:5 (S6)` | S2 | 86.4-73290 | 2026-02-09T06:10:32.747Z |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+6
| { | ||
| "model": "S17", | ||
| "modelDescription": "Sonos Move", | ||
| "softwareGeneration": 2, | ||
| "softwareVersion": "93.1-73290", | ||
| "discoveryDate": "2026-02-09T06:10:26.755Z", |
There was a problem hiding this comment.
The PR adds discovery data for model S17, but the docs generator’s combine command only includes a hard-coded default model list (currently not containing S17-2). Unless the generation was run with --models including S17-2 (or the default list is updated), this new discovery file won’t be reflected in generated docs/services/* outputs. Update the generation step/config to include S17-2 and regenerate the docs outputs so the new device is actually consumed.
Comment on lines
71
to
75
| | Device | Software generation | Software version | Discovery date | | ||
| |:-------|:--------------------|:-----------------|:---------------| | ||
| | `Sonos Play:1 (S1)` | S2 | 85.0-64200 | 2026-01-11T22:44:30.991Z | | ||
| | `Sonos Play:1 (S1)` | S2 | 86.4-73290 | 2026-02-09T06:10:23.572Z | | ||
| | `Sonos One (S13)` | S2 | 63.2-90210 | 2021-07-21T23:31:19.273Z | | ||
| | `Sonos Beam (S14)` | S2 | 64.3-19080 | 2021-08-18T06:04:08.308Z | |
There was a problem hiding this comment.
The services index device table still doesn’t include the newly added Sonos Move (S17) model. After adding generator/sonos-docs/data/sonos-S17-2.json, the docs generation output should list S17 as a supported device (once combine is run with models including S17-2). Regenerate docs/services/index.md (and other service pages) with S17 included so the new device appears in the published docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update and run the generate docs commands for my devices!
Description
I think I ran all of the right commands. If I missed anything then let me know :) Added a new device which is cool!
Your checklist for this pull request
🚨 Please review the guidelines for contributing to this repository.
docs/services/index.mdand thedocs/services/*.mdfiles should not be manually changed, only with the generator.💔 Thank you!