Skip to content

The "Help" button should bring to documentation that prioritizes the needs of less experienced end users

In Power Manager, if you click "Help" button, it brings you to https://docs.xfce.org/xfce/xfce4-power-manager/start.

  • The end user documentation is under the heading "Additional Information". It's not additional, it's the main part. Easy to miss as it is. I think that prominence of documentation should go in order novice -> advanced -> developer. The more experience one has, the better equipped to hunt for the required information and the less hand holding. And starting at the beginning is a general principal.

  • The first item under "Additional Information" is Getting started and is about command line options. Most people probably don't get started with a GUI application by invoking from the cli, and if you do, you probably will look around at how it works by default first. This section should be called something like "Command line options" so that people who are looking for that can find it. It should be moved down the list.

  • The page called Preferences would be better as the most prominent.

I looked at the pages you get to by clicking "Help" in other xfce components and mostly they go directly to end-user oriented pages. Maybe "Help" should go to the "Preferences" page?

P.S. Not sure if this should be in the Power Manager repo or the repo for the documentation. I wasn't able to find where the latter resides. Is it in this gitlab instance somewhere? Aside from what order pages are listed in, the docs have gaps and I was interested to look if there had been any discussion of it. I try to keep this issue narrow to a couple of small changes that would be a big improvement.

Edited by plaster