Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation #26

Open
jgillich opened this issue Mar 29, 2022 · 3 comments
Open

Better documentation #26

jgillich opened this issue Mar 29, 2022 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@jgillich
Copy link
Member

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 jgillich added the help wanted Extra attention is needed label Mar 29, 2022
@pwoznic
Copy link

pwoznic commented Apr 17, 2022

I would like to help with doc improvements.

@repomaa
Copy link
Contributor

repomaa commented Oct 16, 2022

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.

@jgillich
Copy link
Member Author

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 😄

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants