idank / idank/explainshell

Multiline explainer (with popups)

Open
#327 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
14.2k
Forks
851
PR merge metrics
No merged PRs in 30d

Description

What it takes to stitch a prototype that is able to explain multiline shell scripts (or a pieces of them)?

for key in "$@"; do
    eval $(echo "$env" | grep "^export ${key=}")
done

I guess the most complicated part is the layout of explainer text. Maybe it is possible to scatter some overlapping popups around the content..

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points; start by examining how the existing explainer handles the shown multiline shell script and how its layout is organized. Done means a prototype can explain all or parts of the example and present the explanation through usable popups.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, shell
Domain
cli, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.