Closed benperiton closed 1 year ago
Thanks for the suggestion, but currently similar options are generally grouped together, for example:
appendPlugins
, prependPlugins
, replaceAllPlugins
and skipPlugins
readCache
and writeCache
showErrorStack
, extendedErrors
, handleErrors
exportJsonSchemaPath
, exportGqlSchemaPath
, sortExport
graphqlRoute
, eventStreamRoute
, externalGraphqlRoute
, externalEventStreamRoute
, graphiqlRoute
, externalUrlBase
Alphabetically sorting the options would make discovery of related options harder than just looking above/below the option that you're interested in - the page is currently designed more around reading from top to bottom than it is around jumping from point to point (which I'd expect people to use Ctrl-F for).
The other issue is that this list is auto-generated from the source code, so if we were to make this change we would either need to do so in the source code itself (i.e. here: https://github.com/graphile/postgraphile/blob/df1985190c908f0f5f1255fb4558f74c46cae533/src/interfaces.ts), or in the import script.
A better solution might be to either link the individual recommended options to their definitions, or to give them hover text that contains their definitions, but I don't think it's worth investing much time here because the entire configuration system is being overhauled and replaced in V5, and we're using a completely different documentation system (docusaurus) for V5 so there's limited ability to port the changes across.
Ah ok, no worries! I'll close this then as it's not important and no point investing time if its being overhauled :)
When I was looking through the Recommended options, it was a bit confusing having to scroll around/search for what the options were, so I've just put them alphabetically to make it easier to scroll and find what you are looking for