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

Documentation revamp #245

Closed
benjaminjkraft opened this issue Dec 22, 2022 · 0 comments · Fixed by #322
Closed

Documentation revamp #245

benjaminjkraft opened this issue Dec 22, 2022 · 0 comments · Fixed by #322
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@benjaminjkraft
Copy link
Collaborator

benjaminjkraft commented Dec 22, 2022

I think it's probably getting time for v2 of the genqlient documentation. A few thoughts:

  • It might be good to have a clearer philosophy document to explain why we don't generate a single User Go type (or why it's not great to use your gqlgen types on the client), etc.
  • The FAQ is doing way more work than it should, a lot of that should become how-to guides that people might actually be able to find.
  • There are probably some newer options that should make their way into said how-to guides.
  • It's probably time for more examples -- or at least to make space for contributors to add them!

Specific things to fix:

Other ideas are welcome!

@benjaminjkraft benjaminjkraft added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 22, 2022
@benjaminjkraft benjaminjkraft self-assigned this Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant