aPureBase / KGraphQL

Pure Kotlin GraphQL implementation
https://kgraphql.io
MIT License
298 stars 58 forks source link

Replace ambiguous code example in the documentation #178

Closed ryanzidago closed 2 years ago

ryanzidago commented 2 years ago

Hi all,

First thing first, thanks for this library and the tutorial.

The current wording is confusing: it says that the lines should be "added" to the Application.module function, but the code example underneath shows you the whole function, without the configureRouting() call which is necessary to access the graphql playground.

IMHO, we should simply tell the reader to either:

In this PR, I chose the first option, as it is the most straightforward, less error prone and easy to follow.

sangeetds commented 2 years ago

Hi @ryanzidago I think this would be a good update to the README.md. I have forked this repo and trying to maintain it. I thought it would be better if you could open the same PR at https://github.com/sangeetds/KGraphQL instead of me pushing your commit from there. Thanks!

jeggy commented 2 years ago

I'm approving this for now. But we should upgrade the ktor plugin the be available for ktor version 2.x and then update the tutorial to be written for ktor 2.x and using the new ktor project wizard.