search

burner / graphqld

A vibe.d library to handle the GraphQL Protocol written in the D Programming Language
GNU Lesser General Public License v3.0
35 stars 9 forks source link

Better documentation with more examples #77

Open aminya opened 3 years ago

aminya commented 3 years ago

The documentation seems very minimal. Also, the link in the readme doesn't seem to work.

In comparison, here is the extensive documentation of graphql-dotnet: https://graphql-dotnet.github.io/docs/getting-started/introduction

The source of the documentation is MIT licensed, so we can use that and modify it to get a similar doc site. https://github.com/graphql-dotnet/graphql-dotnet/tree/master/docs2

burner commented 3 years ago

First of, sorry for taking so long to respond to this, with anything else than just assign the issue to myself. Just for now have a look at https://github.com/burner/graphqld/blob/master/test/source/app.d#L58

The doc is nice to questions. Currently we are just missing the man-power to be honest. graphq-dotnet has 99 contributors which I think is the max that github shows we have 5 and the from John was made so that there are 2 contributors ;-)

As much as I like reusing the docs/code from other projects, I fear that much of there doc is based on hard work by many people and I would like to find a smart idea to generate most of the docs from the existing unit tests.

In the short term, I'll try to find some time to make at least the first 15 minutes less bad, and as always PRs are always welcome. I mean you already the number 2 contributor to the project.