Repository navigation
Document pairing with a code instead of the token - #107
Open
maximmaxim345 wants to merge 1 commit into
Open
maximmaxim345 wants to merge 1 commit into
maximmaxim345 wants to merge 1 commit into
Conversation
Servers keep the pairing token out of their pairing screen, so users following the docs found no place to paste it.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the documentation-only update to pairing guidance.
No open issues 🎉
What changed in this PR
This documentation-only PR makes code-based pairing the primary user workflow, matching Music Assistant’s pairing screen, and moves pairing-token guidance to Advanced Usage for automation.
Changes:
- Lead with dynamic codes and explain how to read them using
status. - Present static codes as the alternative for manual pairing.
- Move token instructions to Advanced Usage and update navigation links and section anchors.
| File | Description |
|---|---|
| README.md | Replace token-first instructions with dynamic-code pairing via status. |
| docs/wiki/Pairing-a-Player.md | Focus the guide on dynamic and static codes; link to token guidance. |
| docs/wiki/Home.md | Update the pairing guide’s navigation description. |
| docs/wiki/Controlling-the-Player.md | Point pair-token users to Advanced Usage. |
| docs/wiki/Configuration.md | Update the static-code section anchor. |
| docs/wiki/Advanced-Usage.md | Add automation-focused token instructions, including persistence and security guidance. |
Review effort: Balanced
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.
The README and the pairing guide told users to paste the pairing token into the server, but Music Assistant hides token entry when the player offers a dynamic code, which is the default. So users following the docs had nowhere to paste it.
This matches the implementation guide, which says to keep the token for automation and "out of the code-entry screen":
The README and the pairing guide now lead with the dynamic code and the static code. The token moved to Advanced Usage, for scripts and systems that pair the player on the user's behalf.