Documentation is confusing in terms of json vs. gql+-

Moved from GitHub dgraph/4688

Posted by kesor:

Documentation

The documentation for queries, mutations, schema and such are explained using different notations each time - making it very confusing to understand and hard to search for solutions amongst this confusion.

Sometimes an example might be written in GraphQL± notation, sometimes it is the JSON notation, sometimes it has the RDF content type, sometimes it has examples for curl, javascript, java, etc… and sometimes there is just a snippet of text and the reader needs to figure out what that is on his own.

It would be way more beneficial to combine the examples so that each example is shown using all the different methods. Both all the different language clients, as well as RDF vs. JSON vs. GraphQL± notations.

This will also allow the documentation to be more to the point with regards to “what needs to be done”, and then much easier to understand with regards to “how to do it”.

danielmai commented :

It would be way more beneficial to combine the examples so that each example is shown using all the different methods. Both all the different language clients, as well as RDF vs. JSON vs. GraphQL± notations.

Agreed. Thanks for the feedback @kesor.

ctwhome commented :

yes, adding to this, would be possible for you guys (anyway thank you for the efforts) to add a graphql query syntax version in the documents?
On this place: https://dgraph.io/docs/query-language/#count how could I make the query with GraphQL syntax? it is possible to add a tab?