Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Improving in-app documentation and help #939

Open
1 task done
ClementTsang opened this issue Dec 31, 2022 · 0 comments
Open
1 task done

[Feature] Improving in-app documentation and help #939

ClementTsang opened this issue Dec 31, 2022 · 0 comments
Labels
feature Requests for a new feature.

Comments

@ClementTsang
Copy link
Owner

ClementTsang commented Dec 31, 2022

Checklist

Describe the feature request

There's a lot of instances where a question about how to do something simple in bottom can be answered by "look at the docs online" (e.g. a feature exists at all, how to use it, etc.) However, this is, IMO, not a great solution. While it is definitely a good place to put more detailed solutions/answers/things that don't naturally fit (e.g. troubleshooting steps, supported systems, etc.), the in-app documentation/help leaves a lot to be desired.

Some of it can be improved by things like finishing #159, but doing a lookthrough at the ? help menu and cleaning things up in clap/overall can probably help.

It might also help to add a toggleable "bar" a la htop/top that gives useful keybindings.

@ClementTsang ClementTsang added the feature Requests for a new feature. label Dec 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Requests for a new feature.
Projects
None yet
Development

No branches or pull requests

1 participant