Fix docs for GraphQL.NET 3.0.0 release

[sungam3r]

See graphql-dotnet/graphql-dotnet#1843

[sungam3r]

@IvanGoncharov @leebyron Could you please review? GraphQL.NET received a long-awaited update to version 3.0.0 and it took a little change in the documentation.

[JVimes]

@sungam3r, I believe there are a few issues:

• I don't think these changes compile. Try following your documentation as if you were a new user.
• Your changes don't fix the exception in the original issue. See this comment.
• Shouldn't this merge request change the source documentation? Did you follow the publishing instructions?

[sungam3r]

I don't think these changes compile. Try following your documentation as if you were a new user.

Your changes don't fix the exception in the original issue. See this comment.

😕

Shouldn't this merge request change the source documentation? Did you follow the publishing instructions?

Our own documentation http://graphql-dotnet.github.io is now updated automatically after migrating to GitHub Actions.

[joemcbride]

- var json = schema.ExecuteAsync(
+ var json = await schema.ExecuteAsync(

[joemcbride]

@sungam3r I think it's much more intuitive to use async/await.

[sungam3r]

OK, changed.

[JVimes]

@sungam3r What version are you on? It does not work for me:

[Shane32]

You need to import a serialization library as well, such as GraphQL.SystemTextJson, or else pass an implementation of IDocumentWriter to the extension method.

[sungam3r]

@JVimes

OK?

[JVimes]

@Shane32 and @sunapi386 -- No, GraphQL.SystemTextJson is not part of the hello world code sample! Look for yourself here and here and here. The code sample does not have a using statement to bring in the ExecuteAsync extension method. Did you understand the bug report? The code sample does not work.

[Shane32]

No, GraphQL.SystemTextJson is not part of the hello world code sample! Look for yourself here and here and here. The code sample does not have a using statement to bring in the ExecuteAsync extension method. Did you understand the bug report? The code sample does not work.

You're correct. The documentation is wrong, both in this library, and in the graphql-dotnet project samples, for version 3.0. Keep in mind that unlike version 2.4, the json serialization library has been split off from the main project into separate nuget packages, and you will need one of them to make any practical use of the library - you'd need either GraphQL.SystemTextJson or GraphQL.NewtonsoftJson for a sample as small as the "hello world" sample shown.

In addition to the PR here to fix the sample shown here, we will need a PR in the graphql-dotnet repo to fix the file here which when published will update the documentation here. Thank you for pointing this out to us.

[JVimes]

Thank you. I think this will really help.

[orta]

I'm going to close this PR as these changes were manually merged upstream by @ardatan in #936 - thanks for updating the list.

Note: We now have markdown files which allow for longer descriptions on the new code page: https://graphql.org/code/ - so it'd be awesome if you added some code samples etc to help any project on the page shine.