AGENTS

Wiki maintenance instructions

Purpose and audience

This repository is the GitHub wiki for Sonos Volume Bridge. Its primary audience is the final user. Installation, setup, settings, normal operation, privacy, compatibility, and troubleshooting take priority over contributor documentation.

Keep explanations practical, accurate, and written in plain language. Preserve exact labels from the released UI so users can find the described control.

Branch and publication policy

• Work only on the GitHub wiki's default branch. It is currently master.
• Do not create feature branches, pull requests, release branches, or temporary branches in this repository.
• Update the wiki only after a full generally available release has completed successfully.
• Do not update the documented baseline for alpha, beta, draft, prerelease, pull-request, feature-branch, or unreleased develop behavior.
• Preparing files locally does not authorize pushing, changing the remote default branch, or deleting a remote branch.

Before documenting a new release, verify all of the following:

1. The GitHub Release is published and is not marked as a prerelease.
2. The repository's latest-release endpoint returns that exact tag.
3. The release assets for supported platforms are present.
4. User-facing behavior is confirmed from the released tag, not from a newer working tree.

Sources of truth

Use sources in this order:

1. The latest full release tag and its release notes.
2. User-facing implementation and configuration defaults at that tag.
3. Source-controlled project documentation at that tag.
4. Current GitHub issue metadata for tracked limitations.

If sources disagree, do not guess. Correct the wiki only after resolving the discrepancy against the released code.

Limitations and GitHub issues

• Every item presented as a known limitation must link to an existing GitHub issue.
• Verify the issue number, title, state, and release relevance before linking it.
• A closed issue does not mean its fix exists in the documented full release. Compare merge and release timing or inspect the released tag.
• Do not invent an issue number or link an unrelated issue.
• Do not create an issue solely to satisfy documentation unless the user explicitly authorizes it.
• If no suitable issue exists, describe the item as expected behavior or a compatibility note, or request an issue before listing it as a tracked limitation.

Content rules

• Keep Home.md user-first and concise.
• Keep detailed settings in their dedicated pages.
• Use the sidebar for navigation and keep version wording synchronized across Home, sidebar, and footer.
• Keep developer pages secondary to the user guide.
• Do not link this instruction file from any wiki page, sidebar, footer, or external documentation.
• Do not copy secrets, credentials, local paths, network addresses, device identifiers, raw logs, diagnostics, crash dumps, workflow IDs, or other sensitive evidence into the wiki.
• Do not imply affiliation with, sponsorship by, endorsement from, or support by Sonos.
• Do not use em dashes.

Validation before completion

• Confirm the worktree contains only intended wiki changes.
• Confirm the current branch is the GitHub default branch and no additional local branches were created.
• Confirm every wiki link resolves to a page in this repository or an intentional external target.
• Search all pages to ensure this instruction file is not linked or mentioned.
• Search for stale release versions and prerelease claims.
• Check headings, lists, tables, and code fences for valid Markdown.
• Report the documented GA version, branch, files changed, issue links used, and whether anything was pushed.