landai-systems/DevHands

Add example output screenshots or gifs to README

Open

#16 opened on Jul 29, 2025

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Python (3 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Description: Add a "What it looks like" section to the README that shows CLI usage with screenshots or asciinema gifs.

Tasks:

  • Capture the CLI while generating a new app
  • Upload the .gif or embed a link (e.g. via asciinema.org)
  • Add a short caption per screenshot (e.g. “✨ After app creation”)

Contributor guide

Research direction
Use a tool like asciinema to record CLI usage while generating a new app. Then embed the GIF or link in a new 'What it looks like' section in the README, adding short captions.
Tech stack
python
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitscreenshot/recording tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90