processwire / processwire-requests

ProcessWire feature requests.
39 stars 0 forks source link

Make 1st party modules API reference docs more discoverable #448

Open jlahijani opened 2 years ago

jlahijani commented 2 years ago

This isn't a request for ProcessWire core itself, but rather the ProcessWire API reference, which I believe is powered by the "ProcessWireAPI" module: https://processwire.com/api/ref/

The API reference documents all of ProcessWire core and 1st party modules, but there is no direct link to the 1st party commercial modules.

Let's use ProCache as an example. This is the official ProCache API page: https://processwire.com/api/ref/pro-cache/

There's no link to it on any of these pages:

Furthermore, that ProCache API link doesn't exist within any file inside the ProCache module itself.

The only way to discover that page is through one of the following methods:

I believe there should be direct links to first party module API pages in some way.

jlahijani commented 2 years ago

Note: I do see how in debug mode, the "API Variables" accordion lists all API vars and links to the processwire.com API reference accordingly. So it's discoverable in that way as is, but I feel that's hidden away quite a bit.