Skip to content

Commit 52b317f

Browse files
Documentation overhaul: split design history, add ideas backlog, document dev workflow (#2)
* Add docs: extract Live Channels design + ideas backlog Restructure project documentation to separate concerns. The local (gitignored) CLAUDE.md had grown to 663 lines by absorbing a full ~280-line as-built design doc for the Live Channels feature plus a duplicate of the README intro. This splits that material into dedicated docs so CLAUDE.md can return to being a lean developer/agent reference describing current-state reality only. New files (public): - docs/live-channels-design.md — the full Live Channels design, rationale, rejected alternatives, concurrency model, and history (in-place update rule, diff-vs-Tunarr/no-state-file design, franchise matcher safety, per-channel sync state, and the deferred source/target agnosticism goal). Reference-when- you-care material that does not belong inline in the agent guidance file. - docs/ideas.md — an explicitly-stamped "NOT BUILT / subject to change" scratchpad for forward-looking ideas (Plex playlists as channels, logos for multi-title channels, tmdb_franchise match type, source/target agnosticism), kept separate so planned work is never mistaken for shipped behaviour. CLAUDE.md itself is gitignored (intentionally private) and was trimmed locally to 414 lines: README-duplicating intro reduced to a pointer, build-history "slice" prose removed, and the Live Channels section replaced with a short factual summary that links to the new design doc. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Track CLAUDE.md: open-source the developer/agent reference Reverses the earlier decision to keep CLAUDE.md private. Following standard open-source / self-hosted community practice, the project keeps only genuine secrets and personal data out of git (API keys, passwords, internal IPs in config*.json; the user's library in channels.json/*.csv; personal prompt files), and publishes everything else — including the AI/developer guidance file, as is now common for CLAUDE.md / AGENTS.md. - Removed CLAUDE.md from .gitignore and added it to tracking. A leak scan confirmed it contains no IPs, tokens, or passwords (only placeholder example URLs, consistent with README.md). - Resolves the dangling ../CLAUDE.md links in docs/live-channels-design.md and docs/ideas.md, which are now valid on the public repo. - config*.json, channels*.json, *.csv, prompt_for_llm.md, gemresults.json, PROMPT.personal.md, generate_ai.py, .claude/, and _archive/ remain ignored. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * Document GitHub Flow as the mandatory dev workflow in CLAUDE.md Encodes the branch-and-PR discipline as an always-on project rule so it becomes the default behaviour rather than an ad-hoc habit. Replaces the previous three-bullet Git Workflow section (which said "commit and push to origin" directly) with explicit GitHub Flow guidance: - master is the production branch; pushing to it triggers CI -> GHCR -> Watchtower -> live redeploy, so master must stay shippable and is never committed to directly. - Every change goes on a descriptively-named, prefixed branch (feature/ fix/ docs/ chore/) cut from an up-to-date master -- never a generic "wip" name -- one logical task per branch, kept short-lived. - Work is merged via Pull Request only when ready to deploy, then the branch is deleted. - Secrets/personal data stay gitignored. - Docs are updated in the same branch/PR as the code change so they never drift. Includes the concrete git commands for each step as a quick reference. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2587960 commit 52b317f

4 files changed

Lines changed: 768 additions & 1 deletion

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ backend/static/
2424
# Dev / scratch
2525
_archive/
2626
.claude/
27-
CLAUDE.md
2827
generate_ai.py
2928
PROMPT.personal.md
3029
screenshot_*.png

0 commit comments

Comments
 (0)