docs: correct README setup/OOBE + fix data-volume mount #101

2026-06-20T10:57:49-04:00

bvandeusen commented

2026-06-20 10:57:49 -04:00

Brings the README and client/README.md in line with the current product and release pipeline, ahead of the repo being public-facing.

Changes

Highlights — replace the retired "Flutter client in flight" bullet with the native-Android-APK-bundled-in-the-image story.
Quickstart compose — document the purpose of each volume mount, and fix a real bug: the minstrel-data volume now mounts at /app/data (was /data) so it matches the image's MINSTREL_STORAGE_DATA_DIR and generated artefacts (cover collages, artist art, caches) actually persist across container recreates.
Configuration — tie MINSTREL_STORAGE_DATA_DIR to the /app/data mount.
Updating — replace the bogus :v1.0.x scheme with the real tag model (:latest, immutable :vYYYY.MM.DD, :main) and note the bundled APK.
client/README — rewrite the Production section to match release.yml (android-release + needs: ordering, plus the non-tag :latest bundle path); fix "Flutter update banner" → "Android update banner".

Docs-only — release.yml skips via paths-ignore: **/*.md, so no image rebuild.

🤖 Generated with Claude Code

Brings the README and `client/README.md` in line with the current product and release pipeline, ahead of the repo being public-facing. ## Changes - **Highlights** — replace the retired "Flutter client in flight" bullet with the native-Android-APK-bundled-in-the-image story. - **Quickstart compose** — document the purpose of each volume mount, and **fix a real bug**: the `minstrel-data` volume now mounts at `/app/data` (was `/data`) so it matches the image's `MINSTREL_STORAGE_DATA_DIR` and generated artefacts (cover collages, artist art, caches) actually persist across container recreates. - **Configuration** — tie `MINSTREL_STORAGE_DATA_DIR` to the `/app/data` mount. - **Updating** — replace the bogus `:v1.0.x` scheme with the real tag model (`:latest`, immutable `:vYYYY.MM.DD`, `:main`) and note the bundled APK. - **client/README** — rewrite the Production section to match `release.yml` (`android-release` + `needs:` ordering, plus the non-tag `:latest` bundle path); fix "Flutter update banner" → "Android update banner". Docs-only — `release.yml` skips via `paths-ignore: **/*.md`, so no image rebuild. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

bvandeusen added 1 commit 2026-06-20 10:57:49 -04:00

docs: correct README setup/OOBE + fix data-volume mount ad37937949

Bring the README and client/README in line with the current product and
release pipeline ahead of making the repo public-facing:

- Highlights: replace the retired "Flutter client in flight" bullet with
  the native-Android-APK-bundled-in-the-image story.
- Quickstart: document the purpose of each compose volume mount, and fix
  the minstrel-data mount (/data -> /app/data) so it matches the image's
  MINSTREL_STORAGE_DATA_DIR and generated artefacts actually persist.
- Configuration: tie MINSTREL_STORAGE_DATA_DIR to the /app/data mount.
- Updating: replace the bogus :v1.0.x scheme with the real tag model
  (:latest, immutable :vYYYY.MM.DD, :main) and note the bundled APK.
- client/README: rewrite the Production section to match release.yml
  (android-release + needs: ordering, non-tag :latest bundle path).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

bvandeusen merged commit 938dae7163 into main

2026-06-20 10:58:08 -04:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: bvandeusen/minstrel#101