mrlunchbox777 / basic-setup

basic box setup
MIT License
6 stars 3 forks source link

feature: Fix the cheatsheet docs #124

Open mrlunchbox777 opened 4 months ago

mrlunchbox777 commented 4 months ago

Contact Details

mrlunchbox777@gmail.com

Feature Description

The cheat sheet docs are out of date, they should be brought up to standard

Why?

The cheat sheet docs are mentioned in the readme as a way to get basic info about all of the commands and aliases

What-should happen?

Depends on https://github.com/mrlunchbox777/basic-setup/issues/117

There are 2 possible paths forward.

  1. The cheatsheet docs should be removed and covered by the built in help docs provided by bsctl in addition to a command that would need to be built out that describes aliases/bin aliases
  2. The cheatsheet docs need to be updated to reflect current implementation

Option 1 seems more maintainable, but as the blocking issue gets resolved this should become more clear and the justification should be mention in the comments.

Covers this TODO

Steps to Test

This should be updated once the path forward is selected.

Code of Conduct