search

quicksilver / manual

Quicksilver Manual
3 stars 2 forks source link

Should plugins include a link to the respective repo? #9

Open n8henrie opened 2 years ago

n8henrie commented 2 years ago

Example: https://qsapp.com/manual/plugins/eventtriggers/ -> https://github.com/quicksilver/elements.trigger.event-qsplugin

Would be a lot easier to follow the link and update docs rather than going to https://github.com/quicksilver and searching for the repo name.

(Although I guess I ought to tinker with the web search plugin and make that approach easier as well.)

pjrobertson commented 2 years ago

I don't see why not. Something like "View source code" in the bottom of the page, with the link automatically added by the plugindocs.py script. We'd want to make the naming clear, to avoid general users clicking the link looking for support or to file an issue (all issues are filed in quicksilver/quicksilver)

n8henrie commented 2 years ago

It also would be helpful to have some kind of canonical link to the source code, which I've always thought must be somewhere at https://qsapp.com/plugins.php that is escaping me.

Reminds me of trying to find the source code to the Twitter plugin, which was a little befuddling for a while:

Might also increase utilization of the manual (as a route for finding the source code for a given plugin). Currently my approach to finding the repo for a plugin is to:

  1. ddg quicksilver event triggers site:github.com
  2. google quicksilver event triggers site:github.com
  3. quicksilver org repo search at https://github.com/quicksilver

I should probably reorder those to get there a little more quickly.