-
-
Notifications
You must be signed in to change notification settings - Fork 575
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
graphile config doc overhaul #2282
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! Thanks so much for your work on this! 🙌
I've done a lot of editorial, but it's mostly just small edits for for clarity and correctness, or to align with my general writing tone.
I think we should reconsider restoring the middleware page though - plugins aren't just middleware (e.g. Graphile-Build plugins also have inflection, behaviors, gather, schema hooks, etc etc), middleware is just one of the standardized features that plugins offer. In future, I would like to add more dedicated pages for other features (e.g. if we standardize inflection across all our libraries) rather than making the plugin page longer...
Actually what would probably make sense would be to move plugin.md
to plugins/index.md
and then create plugins/middleware.md
as well - group them together under the "plugin" banner, but still a dedicated page.
Thanks for the thoughtful feedback |
This should be ready unless you want to do something about the ResolvePreset pseudocode |
0876a07
to
0a62056
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome; thanks for your hard work on this! 🙌
Description
Taking a full pass on the Graphile Config docs. Some highlights:
and extensible", which I believe better conveys what the library aims to achieve when compared to "provides a standard plugin interface and helpers that can be used across the entire of the Graphile suite"
Checklist
yarn lint:fix
passes.