Skip to content

docs: show StableBar in motion in the README - #383

Merged
Seb-GRAF merged 3 commits into
mainfrom
docs/readme-gifs
Oct 30, 2026
Merged

Seb-GRAF merged 3 commits into
mainfrom
docs/readme-gifs

Conversation

@Seb-GRAF

@Seb-GRAF Seb-GRAF commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

Problem

The README showed StableBar in still images only, so a visitor couldn't see how the bar moves: switching workspaces, opening popups, changing themes or editing the bar in place.

Changes

  • The hero and every section image are now short GIF loops made for the README. Each shows one feature with a still camera and loops back to where it started: the live bar, switching workspaces, opening three popups, washing through the themes, dragging a widget in place, a script becoming a widget, getting a Store package, and a theme change in config.json that the bar follows on save.
  • New sections for workspaces, editing the bar in place and the widget store, each with a GIF and a link to its page in the guide.
  • Configure and Write a widget merge into Settings or JSON and Any script is a widget, keeping their JSON and shell examples.
  • Install, Documentation, Authors, Contributing and License are unchanged.

The GIFs are hosted as GitHub attachments, as the repository doesn't commit recordings. They show the website's demo bar, drawn in HTML (the launch reel's Remotion project), not renders of the app, so they won't follow app changes the way the CI-drawn docs/images do. The user guide still uses themes-*, popups-* and settings-*. Nothing uses hero-* any more, but CI still draws it.

The eight GIFs Hero Workspaces Popups Themes Edit the bar in place Any script is a widget Widget store Settings or JSON

Testing

  • Checked the first, middle and last frames of every loop for framing, legibility and a clean loop point, and the hero at the README's width. Each GIF is 5.5–9 seconds at 15 fps, 880–960 px wide, and between 0.2 and 1.9 MB.
  • Checked every README claim and link against the guide: widgets.md, popups.md, themes.md, settings.md, packages.md#store and configuration.md.
  • Fetched all eight attachment links without signing in: each returns 200 image/gif at its full size.

Merging

Any merge method works: all three commits are docs. The second replaces the first's GIFs, and the third replaces the themes clip, which showed the previous theme under the new one.

Claude Opus 5.5 via Claude Code

@Seb-GRAF
Seb-GRAF enabled auto-merge (squash) October 30, 2026 11:00
@Seb-GRAF
Seb-GRAF disabled auto-merge October 30, 2026 11:02
@Seb-GRAF
Seb-GRAF enabled auto-merge (squash) October 30, 2026 11:07
@Seb-GRAF
Seb-GRAF merged commit 554d295 into main Oct 30, 2026
8 checks passed
@Seb-GRAF
Seb-GRAF deleted the docs/readme-gifs branch October 30, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant