Skip to content

docs(readme): add Screenshots gallery + drop Download section (#54 E)#161

Merged
InstaZDLL merged 2 commits into
mainfrom
docs/readme-screenshots
May 26, 2026
Merged

docs(readme): add Screenshots gallery + drop Download section (#54 E)#161
InstaZDLL merged 2 commits into
mainfrom
docs/readme-screenshots

Conversation

@InstaZDLL
Copy link
Copy Markdown
Owner

@InstaZDLL InstaZDLL commented May 26, 2026

Closes the last sub-item of #54.

Changes

New Screenshots section before Features — six 2×3 captures in an HTML table:

  • Home (profile-aware greeting, mood radio, Daily Mix carousel)
  • Library albums (virtualised grid + Hi-Res badges + A-Z jump)
  • Album detail (multi-disc grouping + side Now Playing panel)
  • Immersive Now Playing (full-bleed artwork + real-time spectrum)
  • Karaoke lyrics (Apple-Music-style word-level highlight)
  • WaveFlow Wrapped (year-in-review with top tracks / BPM / streak)

Table wrapped in localised `markdownlint-disable MD033` comments with a one-line rationale, because Markdown has no clean 2-column image grid with captions.

Drop `## Download` — moved by maintainer into the per-release notes so each version owns its install matrix (one-liners + standalone bundles + Gatekeeper / SmartScreen caveats). README keeps a single `Install` line under the intro pointing at the latest release.

Notes

Six PNGs committed to `docs/screenshots/` at 1920×1080 as shot. Two other captures from the same batch (`now-playing.png`, `wrapped-first-page.png`) were dropped — redundant with the kept set.

Test plan

  • Open the rendered README on the PR's "Files changed" tab; verify the 2×3 grid renders correctly on GitHub
  • Verify the captions are readable at the default GitHub width
  • Verify the "Install" line links to the latest release

Summary by CodeRabbit

  • Documentation
    • Simplification de la section d'installation : renvoi vers la dernière version et one-liners par distribution, suppression des instructions détaillées par paquet/format et des descriptions d'auto-mise à jour.
    • Nouvelle galerie de captures d'écran : grille à deux colonnes avec légendes pour Accueil, Bibliothèque, Détail d'album, Lecteur immersif, Paroles karaoké et WaveFlow Wrapped.

Review Change Stack

Closes the last sub-item of #54 (E: README screenshots) and trims the
heavy Download block now that per-release notes carry the install
flow (one-liners + standalone bundles + Gatekeeper / SmartScreen
caveats) so each version stays self-contained.

- New `## Screenshots` section before Features, with six curated
  captures in a 2x3 HTML table: home, library albums, album detail,
  immersive Now Playing, karaoke lyrics, Wrapped year-in-review.
  Table is wrapped in `markdownlint-disable MD033` / `enable` blocks
  with a comment explaining why HTML beats Markdown here (no clean
  2-column image grid with captions in plain Markdown).
- Replace the Download section (Linux distro one-liners, Windows
  winget + installers, macOS Gatekeeper notes, auto-update caveat)
  with a single "Install" line under the intro pointing at the
  latest GitHub release — keeps the README on-brand and lets the
  release notes own the version-specific install matrix.

Screenshots committed to `docs/screenshots/` at the captured 1920x1080
PNGs as shot by the maintainer. Only the six used files are tracked
(the other two from the same batch — `now-playing.png` and
`wrapped-first-page.png` — were redundant with the kept set).
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

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: b4347bca-c949-48ea-8d9a-335ae3f58532

📥 Commits

Reviewing files that changed from the base of the PR and between f1483d0 and 26dbc43.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

La section d'installation du README est consolidée vers la page "Latest release" et one-liners par OS; une section "Screenshots" en grille deux colonnes a été ajoutée. Les instructions par package/OS et le paragraphe sur les auto-updates ont été supprimés.

Changes

Mise à jour de la documentation du projet

Layer / File(s) Summary
Sections Install et Screenshots
README.md
Remplacement de "Download" par "Install" plus compact avec lien vers la release. Suppression des détails OS/package manager (AUR, COPR, apt, winget), des formats d'installers Windows/macOS et du contenu auto-updates. Ajout d'une section "Screenshots" présentant six captures d'écran dans une grille HTML deux colonnes avec légendes (Home, Library, Album detail, Immersive Now Playing, Karaoke lyrics, WaveFlow Wrapped).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

size: s

Poem

📸 Les screenshots brillent, le téléchargement s'allège,
La doc respire enfin, plus simple et plus allègre,
D'APT à winget l'histoire a fondu,
La page montre l'app, ses vues mises à nu,
WaveFlow sourit, la doc s'est vêtue.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed Le titre suit la convention Conventional Commits avec un scope en kebab-case (docs) et résume clairement le changement principal : ajout d'une galerie Screenshots et suppression de la section Download.
Description check ✅ Passed La description est bien structurée avec une explication claire des changements, les raisons justifiant l'HTML, et un plan de test complet couvrant les points critiques.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-screenshots

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

@InstaZDLL InstaZDLL added scope: docs Docs, README, assets type: docs Documentation size: m 50-200 lines labels May 26, 2026
@InstaZDLL InstaZDLL self-assigned this May 26, 2026
…nced

`wrapped.png` is a portrait story-style capture, the other five
screenshots in the gallery are landscape. Rendered at 50 % column
width, the portrait tile stretched roughly 3× taller than the
karaoke-lyrics tile next to it, leaving a lot of empty whitespace
around the landscape and visually dwarfing the rest of the row.

Inline `max-height: 520px; width: auto;` keeps the aspect ratio and
brings the rendered height in line with its row partner. `align=center`
on the cell pulls the now-smaller image to the middle of the column
instead of letting it hug the left edge.
@InstaZDLL InstaZDLL merged commit 91c1119 into main May 26, 2026
13 checks passed
@InstaZDLL InstaZDLL deleted the docs/readme-screenshots branch May 26, 2026 02:37
InstaZDLL added a commit that referenced this pull request May 26, 2026
GitHub's markdown sanitizer drops inline `style` attributes
(including the `max-height` we set in #161), so the portrait Wrapped
capture rendered at its full natural size after the merge — the
gallery row ended up even more imbalanced than before the cap.

The HTML `height` attribute is in GitHub's allowlist and the browser
keeps the aspect ratio when only one dimension is set, so
`height="380"` brings the Wrapped tile to roughly the same rendered
height as the landscape karaoke-lyrics tile next to it without any
CSS.
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: m 50-200 lines type: docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant