Skip to content

Desktop tutorial: animated step illustrations, progress track and completion card #3376

Closed

Description

@janicduplessis

Problem

The Stim Desktop tutorial panel is a plain checklist. The setup guide and the phone app have illustrations, and the build card has the animated Stim build jar, but the tutorial steps have no artwork, no visible progress beyond "n of N", and no moment that marks a finished step. The maintainer asked for a gamified, illustrated tutorial: an animated illustration per step, smooth transitions between steps, a progress track, a step-complete moment, real stats as rewards, and a completion card.

Evidence

  • The panel is apps/desktop/Sources/StimDesktop/Views/TutorialPanel.swift on main: a list of rows with SF Symbol state icons, and a "Tutorial Complete" label at the end.
  • The approved design preview (rendered with lottie-ios) covers ten step loops, three authored transitions, a step-complete badge, Reduce Motion stills, light and dark.

Cause

There are no tutorial illustration assets yet. The only brand animations are stim-jar-{light,dark}.json and stim-build-{light,dark}.json.

Fix idea

The maintainer approved this plan:

  1. Add a generator, website/scripts/build-stim-tutorial-lottie.py, in the JSON-only style of build-stim-build-lottie.py, with the same jar geometry and palettes. It writes stim-tutorial-{light,dark}.json, one timeline with a loop marker per step, transition markers such as build>parallel, and <step>.still markers for Reduce Motion. It also writes stim-step-done-{light,dark}.json. Bundle both like the jar and build animations.
  2. Panel visuals: an illustration header that plays the transition marker, then loops the step's marker, and cross-fades when there is no transition. Add a progress track and ring, the step-complete badge, and reward chips from data the snapshot already has.
  3. Completion card and achievements.

Stats persistence and navigation evidence for App Logs are tracked separately, because they change behavior.

No sound, because Desktop plays none today. Everything pauses on its still under Reduce Motion.

Activity

  1. janicduplessis commented on Oct 10, 2026

    @janicduplessis
    CollaboratorAuthor

    Claimed: feat/3376-tutorial-illustration-assets

  2. janicduplessis commented on Oct 10, 2026

    @janicduplessis
    CollaboratorAuthor

    Claimed: feat/3376-tutorial-panel-visuals

  3. janicduplessis commented on Oct 10, 2026

    @janicduplessis
    CollaboratorAuthor

    Claimed: feat/3376-tutorial-card

  4. janicduplessis commented on Oct 10, 2026

    @janicduplessis
    CollaboratorAuthor

    Done: #3379 (illustrations, generator, bundling), #3383 (illustrated panel with progress track), #3384 (stats snapshot and Logs evidence, #3377) and #3387 (completion card and achievements).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: desktopapps/desktoparea: websitewebsite/priority: P2Normal; default when unsuretype: featureAdds or changes behavior, including performance and polish

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions