Bash-it / Bash-it/bash-it

Add documentation for all commands

Open
#1,680 10 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Shell
Stars
15.2k
Forks
2.3k
Avg merge
7d 1h
Merged PRs (30d)
2

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

Open the contributing guide

Research direction

Start with the main README and review how commands are currently documented, using `bash-it reload` as an example of a missing entry. Done means the documentation provides a complete list of Bash-It commands; the issue does not identify additional files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.