graphile / graphile/crystal

Consider adding graphile-config-example to docs

Open
#2,291 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
12.9k
Forks
625
Avg merge
5h 23m
Merged PRs (30d)
24

Description

### Feature description

I built small node.js project to demonstrate how library authors might use Graphile Config. My hope is that it's good documentation for Graphile Config, and it's easier to look at this repo than to look through one of the larger Graphile projects for how it uses Config.

https://github.com/jcgsville/graphile-config-example

It may make sense to link this from the Graphile Config docs and update the library author docs in Graphile Config. But I imagine Benjie would probably want to review it first to make sure it's sufficiently aligned with how he expects Graphile Worker to be used.

Also open to moving it to graphile-contrib before linking from the docs if you think that makes sense

I'm in no rush here, and I know you're pushing to get v5 out the door, so please don't feel any pressure to move this forward any time soon 🙂

### Supporting development

I'm happy to make the change to the docs if we agree that it would be useful and we agree that it's ready.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.