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

Solve some low hanging fruit in the documentation #4279

Merged
merged 5 commits into from
Nov 4, 2024

Conversation

JoviDeCroock
Copy link
Member

@JoviDeCroock JoviDeCroock commented Nov 2, 2024

Ultimately I was trying this out to see whether we can tweak the docs easily, it made me realize that our docs are tailored to general GraphQL rather than how do we use this library. It made me come up with a few suggestions

  • We should have a toggle on code examples to switch between buildSchema and programatically creating the schema with i.e. GraphQLObjectType
  • Our documentation starts with a tutorial, this ultimately feels like a mistake, we should lead with an explanation of what GraphQL.JS is and what it aims to do, clearly outlining the goals of this project
  • We should line out use-cases for building on this library and best practices of how to go to production

Resolves #2941
Resolves #2567

Copy link

github-actions bot commented Nov 2, 2024

Hi @JoviDeCroock, I'm @github-actions bot happy to help you with this PR 👋

Supported commands

Please post this commands in separate comments and only one per comment:

  • @github-actions run-benchmark - Run benchmark comparing base and merge commits for this PR
  • @github-actions publish-pr-on-npm - Build package from this PR and publish it on NPM

website/pages/execution.mdx Show resolved Hide resolved
website/pages/execution.mdx Show resolved Hide resolved
@JoviDeCroock JoviDeCroock merged commit 84a49f7 into 16.x.x Nov 4, 2024
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for the executeSync method Documentation of GraphQLScalarType is outdated
2 participants