Bash-it/bash-it

Add documentation for all commands

Open

#1,680 opened on Oct 15, 2020

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Shell (2,304 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (15,045 stars)
PR merge metrics
 (Avg merge 4d 17h) (2 merged PRs in 30d)

Description

I'm wondering whether we want to include this in the documentation. I've checked the main README file, it currently does not provide a complete list of all commands (e.g. bash-it reload). We might want to add that at one point - probably as a separate PR when (hopefully at one point) rework the documentation.

Originally posted by @nwinkler in https://github.com/Bash-it/bash-it/pull/1672#issuecomment-709528853

Contributor guide

Research direction
Examine the current README.md and any documentation files in the repository to identify which commands are already documented. Check command definition files (e.g., in plugins, aliases, or lib) to list all available commands. The issue specifically mentions 'bash it reload' is missing. Aim to create a comprehensive list and add it to the documentation.
Tech stack
shell
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Knowledge of Bash it commandsFamiliarity with MarkdownAccess to Bash it source code
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70