Skip to content

[Feature]: Improve README visuals with short GIFs or richer product storytelling #8

@nikkogibler

Description

@nikkogibler

Area

Documentation

What problem are you trying to solve?

The README now includes a screenshot gallery, but the repo front door can still do more to quickly communicate how the product feels, how the flows connect, and why the project is compelling to contributors.

Proposed solution

Improve the README with richer storytelling elements, such as a tighter “how it works” section, stronger captions, or short GIF-based previews where they add real clarity.

Possible directions:

  • replace one static screenshot with a short GIF of a key user flow
  • add a tighter “how it works” section near the top
  • improve captions so each preview explains why that surface matters
  • better connect the product preview to the open-source contributor opportunity

Acceptance criteria:

  • README remains easy to scan on GitHub
  • any added GIFs or media stay lightweight and intentional
  • visuals and copy improve comprehension, not just aesthetics
  • repo still feels developer-friendly rather than marketing-heavy

Alternatives considered

  • Leave the README in its current screenshot-only state. This is acceptable, but it misses a chance to improve comprehension and contributor conversion.
  • Add lots of visual assets and marketing copy. That would risk making the repo noisier and less developer-friendly.

Scope and impact

  • make the README feel more alive without making it noisy
  • improve product storytelling for first-time visitors
  • add motion or richer narrative where it increases comprehension instead of just decoration

Notes:

This replaces the earlier idea of “add screenshots to the README,” since the screenshot gallery is already in place.

Pre-flight checks

  • I searched existing issues and did not find a duplicate.
  • I explained the problem, not just the desired feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    designUI, UX, visual systems, interaction patterns, layout, and product presentation work.documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions