docs icon indicating copy to clipboard operation
docs copied to clipboard

Organise flyctl sidebar nav for quick scanning

Open catflydotio opened this issue 3 years ago • 3 comments

Things we can do:

  • Standardise the labels, and put them in alphabetical order
  • Put the actual commands in the sidebar to help people get familiar with what's there. I know that used to be there, and it helped me a lot. If we use fly instead of flyctl it'll fit better; perhaps that will mitigate the reason they were removed?

catflydotio avatar Jun 03 '22 17:06 catflydotio

Commands in the main sidebar?

jsierles avatar Jun 03 '22 17:06 jsierles

Ohai @jsierles ! The flyctl nav used to have the form "short description command name" on every line. Now it's only descriptions (the descriptions are desperate for some sort of harmonisation too). I can never find anything and I already know more or less what should be there. Having the command name in there helps with scanning and parsing.

catflydotio avatar Aug 03 '22 14:08 catflydotio

Mitigated with https://github.com/superfly/docs/commit/1fee838570c80ab94697aba754036919a1639d94 which adds the actual commands to the flyctl nav. Descriptions could still use improvement

catflydotio avatar Jan 07 '23 02:01 catflydotio

stale issue - closing

andie787 avatar Jul 22 '24 17:07 andie787