commands are not discoverable (through the UI)

[tpo]

Is your feature request related to a problem? Please describe.

I've read through the releases and was interested in the xray mode I saw. I downloaded the release, started k9s and then wondered - how do I get into the xray mode? Neither CTRL-a nor ? do list it. How is a user supposed to discover:

• the xray command?
• find out about its possible parameters?
• find out about other commands s/he doesn't know?

As far as I can see there is:

• no way to find out through the UI?
• there's no reference to a reference manual or such (I suggest to put a link to https://k9scli.io/#-documentation to the bottom of the ? help page and to k9s help)
• there's no mention of xray on https://k9scli.io/#-documentation which seems to be the "reference manual", I wonder whether other commands are missing there as well
• I couldn't find out any other place where commands could be documented

Describe the solution you'd like

IMHO the best would be to autogenerate command documentation from the source code (i.e. annotation in source code or such) and to display it both:

• in the UI, say at CTRL-h (as help)
• in k9s commands
• if you deem it useful autogenerate https://k9scli.io/#-documentation

So this would be the optimal solution. Minimum useful solution would be to add CTRL-h or some short other shortcut, document that shortcut in the ? help page and to manually add all commands to the CTRL-h page.

Describe alternatives you've considered
AFAI can see, there is no place where all existing commands are documented, so just having one single place where all existing commands are documented would be good already.

Additional context
Add any other context or screenshots about the feature request here.

[derailed]

@tpo I'd like to thank you for this issue! I agree there is indeed much work needed to further document K9s. In my defense, I had published a video when xrays were released and also there is a ctrl-a (documented) shortcut to show all supported commands and aliases (indeed! xray is missing from this list).

Now that said, this is a great place for anyone to help and contribute back to K9s. PR's are open!

[tpo]

@tpo I'd like to thank you for this issue! I agree there is indeed much work needed to further document K9s. In my defense, I had published a video when xrays were released and also there is a ctrl-a (documented) shortcut to show all supported commands and aliases (indeed! xray is missing from this list).

Now that said, this is a great place for anyone to help and contribute back to K9s. PR's are open!

@derailed , thanks for your feedback (and for k9s!).

You are proposing to have xray documented under ctrl-a. That docu page has 3 columns: RESOURCE, COMMAND, APIGROUP. That format doesn't really fit xray well IMO. We could put xray into the COMMAND column, but RESOURCE and APIGROUP would remain empty I guess?

Where would you put the allowed/possible arguments to xray? Shoehorn them into the third column maybe?

I think it'd be good to say a word or two about how the xray command is supposed to be used and what it does. Would you omit that from the ctrl-a page and instead document it on https://k9scli.io/#-documentation?

I am not asking here for somebody to implement all of this, but soliciting a guideline for the "design". I.e. where and how do you see the xray docu fitting into the existing docu infrastructure?