Plugin: README + AGENTS.md rewritten to SPEC.md #33

New issue

Closed

opened 2026-08-19 18:32:56 +00:00 by hermes · 1 comment

hermes commented

2026-08-19 18:32:56 +00:00

Owner

Context

Supersedes #16, which predated SPEC.md and documented login/logout + MusicBrainz. Both files currently describe the removed architecture and command set.

Task

README.md: document the SPEC command set (status, list-playlists, list-tracks, sync [name], match), the apple_music.playlists mapping config (YAML-only credentials), the gateway dependency (deploy + service token; login happens at the gateway UI), the appleplaylists.db state store, and --dry-run.
AGENTS.md: replace the .p8/credential-cache and login-flow warnings with the SPEC's development rules — gateway test doubles, temp BEETSDIR rule (never the global beets library), state-store migration rules.
Remove all MusicBrainz, isrc-backfill, isrc-submit, login, logout, and --write-tags documentation.
Reference SPEC.md as the source of truth; implementation is evidence only.

Acceptance criteria

Both files match the implemented SPEC command set and config shape.
No references to removed features remain.

Ref: SPEC.md (whole document).

## Context Supersedes #16, which predated SPEC.md and documented login/logout + MusicBrainz. Both files currently describe the removed architecture and command set. ## Task - `README.md`: document the SPEC command set (`status`, `list-playlists`, `list-tracks`, `sync [name]`, `match`), the `apple_music.playlists` mapping config (YAML-only credentials), the gateway dependency (deploy + service token; login happens at the gateway UI), the `appleplaylists.db` state store, and `--dry-run`. - `AGENTS.md`: replace the `.p8`/credential-cache and login-flow warnings with the SPEC's development rules — gateway test doubles, temp `BEETSDIR` rule (never the global beets library), state-store migration rules. - Remove all MusicBrainz, `isrc-backfill`, `isrc-submit`, `login`, `logout`, and `--write-tags` documentation. - Reference SPEC.md as the source of truth; implementation is evidence only. ## Acceptance criteria - [ ] Both files match the implemented SPEC command set and config shape. - [ ] No references to removed features remain. Ref: SPEC.md (whole document).

hermes referenced this issue

2026-08-19 18:33:21 +00:00

Plugin: update README + AGENTS.md #16

hermes referenced this issue from a commit

2026-09-05 20:19:11 +00:00

Docs: align usage and development guidance with SPEC (#33)

hermes referenced this issue from a pull request that will close it,

2026-09-05 20:19:18 +00:00

Plugin: complete SPEC reconciliation #36

hermes closed this issue

2026-09-05 20:24:20 +00:00

hermes referenced this issue from a commit

2026-09-05 20:24:22 +00:00

Merge pull request: complete SPEC reconciliation (#36)

hermes referenced this issue

2026-09-05 20:25:10 +00:00

Plugin: drop login, logout, isrc-backfill, isrc-submit (out of scope per SPEC) #22

hermes referenced this issue

2026-09-05 20:25:11 +00:00

Plugin: sync rework (named/full sync, membership replacement, no playlist mutation) #30

hermes referenced this issue

2026-09-05 20:25:11 +00:00

Plugin: match command (interactive + explicit) #31

hermes referenced this issue

2026-09-05 20:25:11 +00:00

Plugin: global --dry-run for all mutating operations #32

hermes commented

2026-09-05 20:25:11 +00:00

Author

Owner

Delivered in merged PR #36 (cb442af). Issue-specific implementation commits:

#22: 4937fad (completed by the SPEC-aligned documentation in 02d5954)
#30: 1e245f2
#31: 9186be5
#32: 0a8ae97
#33: 02d5954

Verification: 95 tests passed; focused Ruff checks, compileall, diff checks, isolated-BEETSDIR command smoke testing, and package build all passed. Issue #34 remains open by maintainer request for the deferred real-library acceptance run.

Delivered in merged PR #36 (`cb442af`). Issue-specific implementation commits: - #22: `4937fad` (completed by the SPEC-aligned documentation in `02d5954`) - #30: `1e245f2` - #31: `9186be5` - #32: `0a8ae97` - #33: `02d5954` Verification: 95 tests passed; focused Ruff checks, compileall, diff checks, isolated-`BEETSDIR` command smoke testing, and package build all passed. Issue #34 remains open by maintainer request for the deferred real-library acceptance run.