idank / idank/explainshell

Auto-scroll on clicking a fragment of the shell

Open
#79 3 comments 3 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

When explaining more complex shell lines you can easily end up with multiple pages of description. While the drawn lines and colors are convenient for tracking down description corresponding to a shell fragment, I'd like to suggest that clicking on the fragment should scroll the page to the top of the relevant documentation.

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

No file, test, or entry point is named. Start by locating the code that renders clickable shell fragments and their corresponding documentation, then verify the page scrolls to the top of the relevant documentation when a fragment is clicked without disrupting the existing line and color tracking.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.