graphql icon indicating copy to clipboard operation
graphql copied to clipboard

Better documentation

Open jgillich opened this issue 2 years ago • 3 comments

Our current documentation in the form of the README will only go so far before becoming convoluted. There are some features that could be explained in more detail, and some features are lacking documentation entirely.

What I'd like to do is to move to more structured content using mkdocs, similar to the Crystal book. But I'm not actually very good at writing documentation. So if anyone's a better writer and interested in contributing, please leave a comment.

jgillich avatar Mar 29 '22 23:03 jgillich

I would like to help with doc improvements.

pwoznic avatar Apr 17 '22 05:04 pwoznic

I can also help, maybe you could set up a repo graphql-crystal/documentation or similar and give us write access. (alternatively we can make prs) but for starters it could be beneficial to give write access so we can setup github actions and github pages for mkdocs.

repomaa avatar Oct 16 '22 18:10 repomaa

Set up a basic mkdocs with the current readme: https://github.com/graphql-crystal/docs

https://graphql-crystal.github.io/docs/

And gave you commit access @repomaa. Have fun :smile:

And sorry @pwoznic, missed your comment. But lmk if you're still interested

jgillich avatar Oct 16 '22 21:10 jgillich