Graphene: Documentation unclear.

[davidyapdy]

The other day, my group (Sanic) had a discussion about graphene and we agree that the documentation is a little unpleasant (pardon my euphemism. Actual: Terrible). It's hard to understand and everything is briefly covered. I think there is a need to cover more ground in the documentation or maybe provide video examples (graphene has no tutorials on YouTube other than talks). I think many would agree based on the issue submitted by the community asking documentation-ish questions.

For an example, under the mutation section, the only defination for mutation is "A Mutation is a special ObjectType that also defines an Input". This doesnt really tell much about mutation. I know that it is expected for your user to read the docs from graphql's official website, but it is also expected to have all the information present in one documentation as well without jumping from one docs to another.

[syrusakbary]

Hi @davidyapdy,

I'm sorry that you find the docs unpleasant/terrible, definitely they need some more love and dedication.

Fortunately, this is an open source project and I'm quite open to contributions in this sense.
Any help to improve the docs will be more than welcome!!

There are some good docs about GraphQL that could help to define/improve the docs:

• http://graphql.org/learn/
• https://learngraphql.com/basics/introduction
• https://rmosolgo.github.io/graphql-ruby/

Please let me know if you would like some guidance in how to contribute into the docs! :)

[davidyapdy]

I'm would love to contribute. I'm also starting to use Graphql for a machine learning app I'm building and would love to share what I understand. Do I email the text doc to you?

[syrusakbary]

Sure! You can email me to: [email protected] or you can post it here... whatever you prefer! :)

[jkimbo]

Hi @davidyapdy . We're currently going through old issues that appear to have gone stale (ie. not updated in about the last 6 months) to try and clean up the issue tracker. If this is still important to you please comment and we'll re-open this.

Thanks!

[CreatCodeBuild]

From a glance, this project is well written (though I consider some API designs hard to use). The best part so far is that it's super easy to test.

But, the documentation is not comprehensive. I consider myself an experienced Python developer and I am fairly familiar with GraphQL. The lib is still hard to get started because it provides many conventions and utilizes some fancy Python programming (magic).

I am sure that this lib is very hard to use for people without GraphQL experiences. More documentation is necessary!

[jkimbo]

@CreatCodeBuild I completely agree! Would you like to contribute some documentation to the project? As someone new to the project I'm sure you would have some interesting insight into places where the documentation is lacking.

[CreatCodeBuild]

I am playing around with the lib. Glad to contribute some example code. The good thing is the source code is quite readable.