linutil icon indicating copy to clipboard operation
linutil copied to clipboard

More Documentation

Open Linuxury opened this issue 1 year ago • 1 comments

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

  • [x] I checked for duplicate issues.
  • [x] I checked already existing discussions.
  • [ ] This feature is not included in the roadmap.

Linuxury avatar Sep 23 '24 17:09 Linuxury

/unlabel 'enhancement' /label 'documentation'

adamperkowski avatar Sep 23 '24 22:09 adamperkowski

I'm moving this to a discussion since there's not much going on here.

adamperkowski avatar Oct 25 '24 12:10 adamperkowski