Skip to content

docs(canvas): document the per-track Canvas feature (#442) - #469

Merged
InstaZDLL merged 1 commit into
mainfrom
docs/track-canvas
Aug 1, 2026
Merged

docs(canvas): document the per-track Canvas feature (#442)#469
InstaZDLL merged 1 commit into
mainfrom
docs/track-canvas

Conversation

@InstaZDLL

@InstaZDLL InstaZDLL commented Aug 1, 2026

Copy link
Copy Markdown
Owner

Catches up the documentation debt for the track Canvas feature merged in #467.

  • docs/features/ui.md — new ## Track Canvas section: sourcing (manual .mp4, magic-byte + size validation, hash-addressed + atomic hard_link publish through the shared media_file::store_hash_addressed_mp4 helper into the never-evicted per-profile canvas/ dir), the Show Canvas toggle (useCanvasEnabled, default OFF), precedence (Canvas > motion cover > static cover), prefers-reduced-motion / radio / Spotify exclusions, and the useTrackCanvas lookup guards ({id, profileId} tag + per-track generation + monotonic profile-generation token) + frozen picker target.
  • CLAUDE.md — Canvas clause in the UI feature catalogue.
  • docs/README.md — mention immersive view + track Canvas in the UI & UX row (re-padded to keep table alignment).

Docs-only, no code. The root README feature matrix was deliberately left unchanged — its UI row is already the widest cell, so adding Canvas would force a full-table re-pad for a summary line already covering the immersive now-playing experience.

Summary by CodeRabbit

  • Nouvelles fonctionnalités

    • Ajout de la documentation du Canvas de piste, une vidéo MP4 muette et en boucle affichée derrière la vue de lecture.
    • Précision des options de sélection, de stockage par profil et de contrôle utilisateur.
    • Documentation des priorités d’affichage et des exclusions, notamment en mode réduction des animations, pour la radio et Spotify.
  • Documentation

    • Mise à jour de la documentation générale des fonctionnalités d’interface et d’expérience utilisateur.

Catch up the docs debt for the merged track Canvas (PR #467):
- docs/features/ui.md: new "Track Canvas" section — sourcing (manual mp4,
  hash-addressed + atomic hard_link publish via the shared media_file helper),
  the Show Canvas toggle (default OFF), and the useTrackCanvas lookup guards
  (id/profileId tag + profile-generation token).
- CLAUDE.md: Canvas clause in the UI feature catalogue.
- docs/README.md: mention immersive view + track Canvas in the UI & UX row.
@InstaZDLL InstaZDLL added scope: docs Docs, README, assets type: docs Documentation size: s 10-50 lines labels Aug 1, 2026
@InstaZDLL InstaZDLL self-assigned this Aug 1, 2026
@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 0b76efc5-df0c-4ab8-9fc6-c049e0924a86

📥 Commits

Reviewing files that changed from the base of the PR and between b5a8909 and 07d78e8.

📒 Files selected for processing (3)
  • CLAUDE.md
  • docs/README.md
  • docs/features/ui.md

📝 Walkthrough

Walkthrough

La documentation ajoute Track Canvas au périmètre UI. Elle décrit les vidéos MP4 par piste, leur import et stockage, les commandes de gestion, les priorités d’affichage, l’activation par défaut, les exclusions et les protections contre les résultats obsolètes.

Changes

Documentation Track Canvas

Layer / File(s) Summary
Description et périmètre de Track Canvas
docs/features/ui.md, CLAUDE.md, docs/README.md
La documentation décrit la lecture de vidéos MP4 locales, l’import validé, le stockage par hash, les commandes de gestion, les règles d’activation, les exclusions et la gestion des courses asynchrones.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning La description résume précisément les changements, mais elle omet les sections de tests, de checklist et de problèmes liés du modèle. Ajouter les étapes de validation exécutées, compléter la checklist du modèle et remplacer « Closes # » par une référence d’issue valide ou supprimer cette section.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed Le titre décrit clairement la documentation de la fonctionnalité Canvas par piste et suit le format Conventional Commits.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/track-canvas

Comment @coderabbitai help to get the list of available commands.

@InstaZDLL
InstaZDLL merged commit 256d3dd into main Aug 1, 2026
13 checks passed
@InstaZDLL
InstaZDLL deleted the docs/track-canvas branch August 1, 2026 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope: docs Docs, README, assets size: s 10-50 lines type: docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant