Skip to content

Retake the screenshots and cut the Metadata section down to its neighbours' size - #49

Merged
revtex merged 2 commits into
mainfrom
readme-screenshots
Sep 2, 2026
Merged

Retake the screenshots and cut the Metadata section down to its neighbours' size#49
revtex merged 2 commits into
mainfrom
readme-screenshots

Conversation

@revtex

@revtex revtex commented Sep 2, 2026

Copy link
Copy Markdown
Owner

Three problems, all in the README.

Every screenshot predated the Metadata tab. The nav strip in all three showed four tabs where the app has five — the first thing a reader compares against their own window, and it disagreed.

The Advanced shot was worse than stale. It still showed the three advertisement switches that 0.2.0 replaced with a single Record dropdown, two filename presets instead of five, and a line of prose under each setting from before those became tooltips. Someone following it would have gone looking for controls that are not there.

The Metadata section did not read like its neighbours. 64 lines against 28 and 38 for the sections either side, and the only UI section with no screenshot at all.

What changed

settings.png and advanced.png are retaken from a staged profile, which is why the paths read C:\Music\Offstream and C:\ffmpeg\bin\ffmpeg.exe — both are the examples the surrounding prose already calls examples, and neither carries a real user name. Settings is cropped to 990px as it was before, keeping the footer's absolute settings path out of a published image. Its provider now reads Last.fm rather than Nothing, so the image agrees with the paragraph below it that says Offstream starts with Last.fm selected and asks for a key on first run.

metadata.png is new: the scanned library on the left with cover art and Will change badges, the editor for the selected track on the right, and the search box pinned to the foot of the pane.

The section itself drops from 64 lines to 49 — and that now includes the screenshot, so the prose fell further than the count suggests. Two paragraphs were doing work the image does better: the list beside the editor, the ten field names, the was … line, the badge. Those become the image plus four lines.

What is kept in words is the part an image cannot show:

  • clearing a box stops Offstream changing that tag rather than erasing it
  • a comma separates genres but not names, because "Earth, Wind & Fire" is one band

The rationale for why the editor sits beside the list instead of inside the row is design history. It belongs in docs/MODERNIZATION-PLAN.md, where it already is, not in a page telling someone how to retag a file.

What is deliberately not here

record.png is untouched. Its only fault is the missing tab, and an honest replacement needs Spotify playing into a live recording — the cover art, the moving level meter and the elapsed clock are what make it the page's hero shot, and none of it can be staged.

Verification

  • .\build.ps1 -VerifyFormat — clean.
  • Both retaken pages captured from this branch's build, so the five-tab nav strip is consistent across all three new images.
  • Staging (C:\Music\Offstream, C:\ffmpeg\bin, the temp profiles) removed afterwards; the real %APPDATA%\Offstream\settings.json was never written to — every capture ran under OFFSTREAM_HOME.

no-changelog: nothing about the shipped application changed.

…bours' size

Every screenshot in the README predated the Metadata tab, so the nav strip in all
three showed four tabs where the app has five — the first thing a reader compares
against their own window, and it disagreed. The Advanced shot was worse than stale:
it still showed the three advertisement switches that 0.2.0 replaced with a single
Record dropdown, two filename presets instead of five, and a line of prose under
each setting from before those became tooltips. Someone following it would have
gone looking for controls that are not there.

Settings and Advanced are retaken from a staged profile, which is why the paths in
them read C:\Music\Offstream and C:\ffmpeg\bin\ffmpeg.exe — both are the examples
the surrounding prose already calls examples, and neither carries a real user name.
Settings is cropped to 990 as it was before, which keeps the footer's absolute
settings path out of a published image. The provider now reads Last.fm rather than
Nothing, so the shot agrees with the paragraph below it that says Offstream starts
with Last.fm selected and asks for a key on first run.

Metadata had no screenshot at all, alone among the pages, and the section describing
it ran to 64 lines against 28 and 38 for the two either side of it. Most of that was
two paragraphs of prose doing work a screenshot does better: the list beside the
editor, the ten field names, the "was ..." line, the badge. Those become the image
plus four lines. What is kept in words is the part an image cannot show — that
clearing a box stops Offstream changing a tag rather than erasing it, and that a
comma separates genres but not names, because "Earth, Wind & Fire" is one band. The
rationale for why the editor sits beside the list instead of inside the row is
design history and belongs in the plan, where it already is, not in a page telling
someone how to retag a file.

record.png is deliberately untouched. Its only fault is the missing tab, and an
honest replacement needs Spotify playing into a live recording — cover art, a
moving level meter and an elapsed clock are what makes it the page's hero shot, and
none of it can be staged.
@revtex revtex added the no-changelog This PR changes nothing a user would see, so CHANGELOG.md stays as it is label Sep 2, 2026
The pane shows five of the ten fields the section lists, with the rest behind a
scrollbar. That is the two-region layout working as designed, but a reader counting
five against ten has no way to tell it from a screenshot taken before the other five
existed — which is the fault this branch is fixing everywhere else.
@revtex
revtex merged commit d9358bc into main Sep 2, 2026
6 checks passed
@revtex
revtex deleted the readme-screenshots branch September 2, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR changes nothing a user would see, so CHANGELOG.md stays as it is

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant