Discoverability of features/commands

[rsyring]

Is there a way to make discoverability of plugin features easier?

My current case in point is the snippets plugin. I've been trying to come up with an easier way to quickly add a snippet so I started looking at the source code. I discovered "snip" was a query trigger, but I had no idea that was how it worked. I had always just searched for a snippet by name, it came up, and I selected it to get it into the clipboard.

While writing this issue, I just took a closer look at the query tab and realized it was getting updated after plugins are activated. Can't believe I didn't realize that was there sooner. :o/

So, "snip +" will let me add a new one snippet. The source of the plugin makes me think I should be able to choose to edit one too, but I can't seem to find the way to trigger that alternative action if it exists.

But the bigger issue then is discoverability. I wonder how many cool features are hidden in Albert and its ecosystem but no one uses them b/c there its no easy to learn about them.

Two other plugins: "PATH" and "Kill Process" have no explanation on how to use them. I can move over to the query tab after activating them and see if a new query is available. But what about any extra functionality?

Or the Documentation plugin. I just tried it and installed the Python docs. But "docs pathlib" doesn't return anything about the pathlib module, so I don't know what to do with it next.

Maybe each plugin could have the option to include a readme.md that would be shown in the Albert settings UI? Maybe some things that are programmatically available, like the query or alternate actions, could be automatically shown as part of the built-in docs for the plugin which would be displayed with any readme content?

Just some ideas. :) Love Albert. Thanks for all the effort you've put into it!

[ManuelSchneid3r]

The first approach was the inline input hint. Then we once had this README.md which was displayed in the settings. Then came internationalization and the README.md was dropped because its not localizable. Now the documentation should go into the settings widget, however lots of plugins dont have them. Also the python plugins are not internationalized yet. But yes there should definitvely be more documentation of the features. Note that every queryhandler plugin (so all but python plugins plugin) is a trigger query handler plugin.

[ManuelSchneid3r]

Or the Documentation plugin. I just tried it and installed the Python docs. But "docs pathlib" doesn't return anything about the pathlib module, so I don't know what to do with it next.

This seem to be a bug in the docs plugin.

[ManuelSchneid3r]

This seem to be a bug in the docs plugin.

albertlauncher/plugins@fda6212