Auto-sync Chriss-MacBook-Pro 2026-06-11 12:51

2026-06-11 12:51:20 -05:00
parent 08aeb65d83
commit 8a35ebb095
5 changed files with 48 additions and 0 deletions
@@ -0,0 +1,4 @@
+- [User profile](user_profile.md) — project owner, manages releases, handles community requests
+- [Community user avdp](project_community_user_avdp.md) — Docker/NAS user on Fedora with virtual serial port, may PR package manager detection
+- [Vestaboard API](project_vestaboard_api.md) — issue #48, implement Vestaboard Local API for HA integration
+- [Always bump VERSION](feedback_version_bump.md) — VERSION file must match release tag before creating a release
@@ -0,0 +1,11 @@
+---
+name: Always bump VERSION with each release
+description: VERSION file must be bumped before creating a GitHub release tag, every time
+type: feedback
+---
+
+Always bump the VERSION file as part of the same commit (or immediately prior) when creating a new GitHub release. Do not create a release tag without the VERSION file matching.
+
+**Why:** The app's update checker compares the local VERSION file against the latest release tag. If VERSION isn't bumped, the updater shows the wrong version after "installing" an update.
+
+**How to apply:** When doing commit + push + release, include the VERSION bump in the commit. If multiple releases happen in one session, bump VERSION for each one — don't assume the first bump covers subsequent releases.
@@ -0,0 +1,11 @@
+---
+name: Community user avdp - Docker/NAS use case
+description: Discord user avdp runs splitflap-os on a Fedora NAS via virtual serial port over MQTT, may PR package manager detection
+type: project
+---
+
+Discord user avdp runs splitflap-os on a Fedora-based NAS (not a Pi), using a virtual serial port at /tmp/ttyVSF0 that relays to MQTT. Wants Docker container support. May submit a PR to detect the correct package manager (dnf vs apt) in the install script and add a prompt to skip networking service install.
+
+**Why:** Represents the non-Pi deployment use case driving the configurable serial port and --skip-network features.
+
+**How to apply:** When reviewing PRs for install script changes around package manager detection, this is the context. The serial port and --skip-network features (v0.2.5/v0.2.6) were built for this user's workflow.
@@ -0,0 +1,15 @@
+---
+name: Vestaboard API feature request
+description: Issue #48 requests implementing Vestaboard Local API compatibility for Home Assistant integration
+type: project
+---
+
+GitHub issue #48 (opened 2026-06-04 by ze-conehead) requests implementing the Vestaboard Local API so existing Vestaboard-compatible tools work with splitflap-os. Main value is the Home Assistant Vestaboard integration.
+
+Key endpoints: POST /local-api/message (send 2D char code array), GET /local-api/message (read current state), POST /local-api/enablement (enable API). Auth via X-Vestaboard-Local-Api-Key header — can skip for now per requester.
+
+Vestaboard uses custom character codes (A-Z → 1-26, digits → 27-36, colors 63-70). Grid: 6×22 (Flagship) or 3×15 (Note, matches splitflap default).
+
+**Why:** Unlocks HA Vestaboard integration without writing a custom HA component.
+
+**How to apply:** When implementing, focus on the 3×15 Note form factor mapping. Need a translation layer between Vestaboard char codes and splitflap's FLAP_CHARS.
@@ -0,0 +1,7 @@
+---
+name: User profile
+description: csader is the creator/maintainer of splitflap-os, manages GitHub releases, and handles community feature requests
+type: user
+---
+
+Owner and primary developer of the splitflap-os project. Manages the GitHub repo (csader/splitflap-os), handles feature requests from Discord community users, and does releases directly to main. Comfortable with the full workflow: implement, commit, push, release in one pass.