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

More Documentation #657

Open
2 tasks done
Linuxury opened this issue Sep 23, 2024 · 1 comment
Open
2 tasks done

More Documentation #657

Linuxury opened this issue Sep 23, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Linuxury
Copy link

Linuxury commented Sep 23, 2024

Future Prof New entries

This tool is in desperate needs for better documentation for not just the name of new entries but also for what they are intended to be used. Not to forget the lack of documentation on keyboard mapping not added anywhere 😞

Describe the solution you'd like

A good solution would be to integrate a simple template to fill that information at the time of submission or to be able to modify them if they have already been added.

Describe alternatives you've considered

A would suggest something like this to start with

[Category]
[Sub category] if any
[Name]
[Description] what it does is a must for people new to Linux, since this is a tool that aims to help new user it should not be ignored in my opinion.
[Hot keys] if any, for example how to pull Rofi or how to use neovim, etc... you guys get my point.

Additional context

I know it's great if you know those things by heart, but won't kill you if you help the new guy at the same time.

Checklist

  • I checked for duplicate issues.
  • I checked already existing discussions.
  • [ ] This feature is not included in the roadmap.
@Linuxury Linuxury added the enhancement New feature or request label Sep 23, 2024
@adamperkowski
Copy link
Contributor

adamperkowski commented Sep 23, 2024

/unlabel 'enhancement'
/label 'documentation'

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants