Skip to content

docs: doc-vs-software audit round 2 (zero2w source, hw claims, diagnostic path, changelog anchors) - #656

Merged
lollonet merged 2 commits into
mainfrom
docs/diagnostic-client-path
Jul 26, 2026
Merged

docs: doc-vs-software audit round 2 (zero2w source, hw claims, diagnostic path, changelog anchors)#656
lollonet merged 2 commits into
mainfrom
docs/diagnostic-client-path

Conversation

@lollonet

@lollonet lollonet commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Second doc-vs-software audit pass, verified against code:

Finding File Fix
P2 HARDWARE.{md,it.md} Pi Zero 2 W bullet said snapclient comes "from upstream badaix .deb" — setup-zero2w.sh:152 prefers the snapMULTI-built .deb (v0.35.0-snapmulti1), falls back to distro apt. Never badaix. Corrected.
P2/P3 HARDWARE.{md,it.md} "Recommended Setups" listed boards absent from "Tested Combinations", implying validation. Added a note: picks are from the validated PCM5122 family, expected-to-work; only "Tested Combinations" units are physically verified.
P3 TROUBLESHOOTING.{md,it.md} Diagnostic-bundle command documented only /opt/snapmulti/...; player-only installs stage it to /opt/snapclient/... (staging-manifest.sh). Both call-sites now note the client path.
P3 CHANGELOG.md Two stale IPv6 anchors in the ADR-007 entry (#ipv6-disabled-*#ipv6-enabled-*) after the target headings were renamed.

Doc-only, no code paths touched. Extends the #652 doc-vs-software audit.

🤖 Generated with Claude Code

The manual diagnostic-bundle command documented only
/opt/snapmulti/scripts/diagnostic.sh. On a player-only (Audio Player)
install the script is staged to /opt/snapclient/scripts/diagnostic.sh
(staging-manifest.sh STAGING_CLIENT_OPTIONAL, dest "scripts"), so the
documented path does not exist there and the command fails.

Both call-sites (the "diagnostic bundle" section and the "symptom" inline
mention) now point client users at the /opt/snapclient path. Mirrored to
the Italian doc. CHANGELOG updated.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011xbiRoWQLVmKDxNkBqLsvk
@github-actions

Copy link
Copy Markdown

Ready to merge — no issues found

Small, accurate documentation fix. Verified the underlying claim: CLIENT_DIR="/opt/snapclient" (scripts/firstboot.sh:204), and staging-manifest.sh stages scripts/diagnostic.sh into the client bundle, so /opt/snapclient/scripts/diagnostic.sh is the correct path on player-only installs. Both call-sites in docs/TROUBLESHOOTING.md are updated, and docs/TROUBLESHOOTING.it.md mirrors both changes correctly. CHANGELOG.md entry added under [Unreleased] > Documentation.

Checklist

  • ✅ Documentation SSOT — single owner (docs/TROUBLESHOOTING.md), no duplication introduced
  • ✅ Italian translation kept in sync (docs/TROUBLESHOOTING.it.md)
  • ✅ CHANGELOG.md updated under [Unreleased]
  • ✅ Claim verified against actual script behavior (firstboot.sh, staging-manifest.sh)
  • ➖ Docker/Infra, Shell Scripts, Python, Tests, CI/CD, Security — not applicable (docs-only diff)

…changelog anchors

Doc-vs-software audit round 2 (extends #656):

- HARDWARE.{md,it.md}: Pi Zero 2 W client-native bullet said snapclient is
  installed "from the upstream badaix .deb". Actual chain (setup-zero2w.sh:152):
  prefer the snapMULTI-built .deb (snapclient-deb/v0.35.0-snapmulti1), fall back
  to distro apt (Trixie 0.31 / Bookworm 0.27) — never badaix. Corrected.
- HARDWARE.{md,it.md}: "Recommended Setups" listed boards not in the narrower
  "Tested Combinations" matrix, implying launch validation. Added a note: the
  picks come from the validated PCM5122 DAC family and are expected-to-work;
  only "Tested Combinations" units are physically verified end-to-end.
- CHANGELOG.md: fixed two stale IPv6 anchors in the ADR-007 entry after the
  target headings were renamed (disabled -> enabled).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011xbiRoWQLVmKDxNkBqLsvk
@lollonet lollonet changed the title docs(troubleshooting): note player-only diagnostic.sh path docs: doc-vs-software audit round 2 (zero2w source, hw claims, diagnostic path, changelog anchors) Jul 26, 2026
@github-actions

Copy link
Copy Markdown

Ready to merge — no issues found

Reviewed the new commits in this round (docs(hardware): fix zero2w snapclient source + recommended-hw claim; changelog anchors) — the docs(troubleshooting): note player-only diagnostic.sh path commit was already reviewed and approved in a prior round, not re-reported here.

Verified each new claim against the actual code/docs:

  • Zero2W snapclient sourceclient/common/scripts/setup-zero2w.sh:152-220 confirms it prefers the snapMULTI-built .deb (snapclient-deb/v0.35.0-snapmulti1) and falls back to distro apt; never badaix upstream. Doc correction is accurate.
  • Recommended Setups validation note — cross-checked against docs/HARDWARE.md's own "Tested Combinations" table (line 320+) and existing validation language (line 137, 336): the boards in "Recommended Setups" (DAC2 Pro, DAC+ Zero, InnoMaker HAT variants) are indeed broader than the physically-tested set. The added caveat is accurate and non-duplicative.
  • CHANGELOG anchor fixes — computed GitHub's anchor-slug algorithm for both target headings: docs/ADVANCED.md:368 ("## IPv6 enabled by default") → #ipv6-enabled-by-default, and docs/TROUBLESHOOTING.md:286 ("## IPv6 enabled by default — is this expected?") → #ipv6-enabled-by-default--is-this-expected. Both match the corrected links exactly.
  • Italian translations (HARDWARE.it.md) mirror both EN changes, including matching anchor #combinazioni-testate.

Checklist

  • ✅ Documentation SSOT — no duplication, single-owner topics (HARDWARE.md, CHANGELOG.md)
  • ✅ Italian translations kept in sync
  • ✅ CHANGELOG.md updated under [Unreleased] for this round's changes
  • ✅ Claims verified against actual script behavior and doc anchors
  • ➖ Docker/Infra, Shell Scripts, Python, Tests, CI/CD, Security — not applicable (docs-only diff)

@lollonet
lollonet merged commit b41c0b7 into main Jul 26, 2026
4 checks passed
@lollonet
lollonet deleted the docs/diagnostic-client-path branch July 26, 2026 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant