Skip to content
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

Merged
merged 23 commits into from
Dec 19, 2024
Merged

Conversation

jcgsville
Copy link
Contributor

Description

Taking a full pass on the Graphile Config docs. Some highlights:

  • Changing the 1-liner to "Graphile Config helps Node.js library authors make their libraries configurable
    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"
  • Add a lot more detail around middleware & authoring plugins.
  • Reorganize docs around needs of different users: library consumers, plugin authors, and library authors (though I haven't changed much of the content for library authors)

Checklist

  • My code matches the project's code style and yarn lint:fix passes.

Copy link

changeset-bot bot commented Dec 15, 2024

⚠️ No Changeset found

Latest commit: 0a62056

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jcgsville jcgsville marked this pull request as ready for review December 17, 2024 17:03
Copy link
Member

@benjie benjie left a 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.

utils/website/graphile-config/index.md Outdated Show resolved Hide resolved
utils/website/graphile-config/library-authors.md Outdated Show resolved Hide resolved
utils/website/graphile-config/plugin.md Outdated Show resolved Hide resolved
utils/website/graphile-config/preset.md Outdated Show resolved Hide resolved
utils/website/graphile-config/preset.md Outdated Show resolved Hide resolved
utils/website/graphile-config/preset.md Outdated Show resolved Hide resolved
utils/website/graphile-config/preset.md Outdated Show resolved Hide resolved
utils/website/src/components/HomepageFeatures/index.js Outdated Show resolved Hide resolved
@jcgsville
Copy link
Contributor Author

Thanks for the thoughtful feedback

@jcgsville jcgsville mentioned this pull request Dec 18, 2024
1 task
@jcgsville
Copy link
Contributor Author

This should be ready unless you want to do something about the ResolvePreset pseudocode

#2282 (comment)

@benjie benjie force-pushed the graphile-config-doc-revamp branch from 0876a07 to 0a62056 Compare December 19, 2024 11:48
Copy link
Member

@benjie benjie left a 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! 🙌

@benjie benjie merged commit dd081e8 into graphile:main Dec 19, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants