Skip to content

Improve flow of documentation around GraphiQL #4340

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

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

benjie
Copy link
Member

@benjie benjie commented Feb 4, 2025

See graphql/graphql.github.io#1951

For someone following the tutorial they may well get as far as running the server (node server.js) and then attempt to visit their new API and get confused because they're met with an error such as {"errors":[{"message":"Missing query"}]}.

This PR adds some joining text to make it clear this is the expected outcome, and they must read on to get the GraphiQL IDE set up so that they can write queries.

@benjie
Copy link
Member Author

benjie commented Feb 4, 2025

(Copied from graphql/graphql.github.io#1956)

Copy link

github-actions bot commented Feb 4, 2025

Hi @benjie, 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

@JoviDeCroock JoviDeCroock merged commit 6afd9d1 into 16.x.x Feb 5, 2025
32 checks passed
JoviDeCroock pushed a commit that referenced this pull request May 4, 2025
See graphql/graphql.github.io#1951

For someone following the tutorial they may well get as far as running
the server (`node server.js`) and then attempt to visit their new API
and get confused because they're met with an error such as
`{"errors":[{"message":"Missing query"}]}`.

This PR adds some joining text to make it clear this is the expected
outcome, and they must read on to get the GraphiQL IDE set up so that
they can write queries.
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.

3 participants