Skip to content

docs: rewrite soundpacks guide - #28

Merged
ctoth merged 1 commit into
ctoth:masterfrom
daiverd:docs/soundpacks-guide
Aug 6, 2026
Merged

docs: rewrite soundpacks guide#28
ctoth merged 1 commit into
ctoth:masterfrom
daiverd:docs/soundpacks-guide

Conversation

@daiverd

@daiverd daiverd commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites docs/soundpacks.md, verifying every claim against the actual source (internal/sounds/mapper.go, internal/hooks/parser.go, internal/soundpack/*.go, internal/cli/soundpack_*.go, internal/config/xdg.go) and, for the runtime-resolution behavior, against a locally built binary
  • Fixes an inaccurate claim that hand-copied directory packs are auto-resolved at runtime — they aren't without a soundpack_paths entry (or a literal default_soundpack path); without one, Claudio silently falls back to the platform pack. New Discovery Vs. Runtime Resolution section documents this
  • Adds a per-OS "Where Soundpacks Live" table (Linux/macOS/Windows/WSL) for directory packs, JSON packs, managed git clones, the git registry, and config.json
  • Clarifies there's no shared soundpack marketplace — the "registry" is local bookkeeping for your own managed git packs
  • Notes that soundpack update is pull-on-demand only, never automatic
  • Reorders the whole page around reader intent instead of pack file format: Using A Pack (switch/install/remove, no authoring required) → Building A Pack (directory/JSON formats, validation, tracking) → How Sound Selection Works (fallback chains, command parsing — for debugging or extending Claudio)

Test plan

  • Skim rendered page for broken anchors/links (all cross-references use kramdown auto-generated heading IDs, unaffected by heading-level changes)
  • Spot-check the per-OS path table against internal/config/xdg.go / github.com/adrg/xdg

🤖 Generated with Claude Code

… structure

The old page grouped sections by pack file format and had a couple of
claims that didn't match the code (e.g. hand-copied directory packs
were said to be auto-resolved at runtime; they aren't without a
soundpack_paths entry, verified against internal/cli/cli.go and by
running the built binary). Rewritten and reordered around why someone
opens the page: using an existing pack, building your own, then how
sound selection works internally for anyone extending Claudio. Adds
per-OS storage paths, a Discovery Vs. Runtime Resolution explainer,
and a note that soundpack updates are pull-on-demand only.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ctoth
ctoth merged commit fdd35ca into ctoth:master Aug 6, 2026
8 checks passed
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.

2 participants