Move documentation to readthedocs.org

[KoditkarVedant]

Hello @joemcbride,

I've gone through the graphql-dotnet document but I feel the current document doesn't look good. I think we should move our documentation to https://readthedocs.org/

If you say yes, I would like to work on this.

[joemcbride]

I have been looking at either https://vuepress.vuejs.org/ or https://www.gatsbyjs.org/ as an alternative. Vuepress looks a bit easier to use out of the box, though I prefer React and I like that Gatsby is React+GraphQL.

This repo is the statically generated site, the actual docs currently live here: https://github.com/graphql-dotnet/graphql-dotnet/tree/master/docs , which is using st-docs. Admittedly I'm a bit adverse to readthedocs due to the python dependency.

The docs can get a quick facelift with just a little bit of html + css tweaks with the existing files if that is currently your main concern?

[KoditkarVedant]

The alternatives are good. Yup, we can get a quick facelift with ccs tweaks but we need to maintain it. Why invest time in it as we get all this handled for us out of the box. What do you think?

We can use the https://www.gatsbyjs.org/. I didn't have a liking for readthdocs it just that I only aware of that.

[joemcbride]

With Gatsby you still have to "bring your own" html + css, so that would still be work that has to be done.

https://medium.com/squadlytics/how-we-switched-to-documentation-as-code-with-gatsby-js-and-netlify-part-1-2-1f57ad732a05

[KoditkarVedant]

Oh. I thought Gatsby must be providing some default document template which we could use.

[joemcbride]

Start of gatsby docs here: https://github.com/graphql-dotnet/graphql-dotnet/tree/docs2/docs2

[joemcbride]

Image preview:

[joemcbride]

And the new docs are live! They still need some re-org, but at least they look tons better. At least I think so. https://graphql-dotnet.github.io/

[KoditkarVedant]

@joemcbride, Docs look Awesome!. I tried to run the docs2 on my local machine but facing some problems, I think now it should work. Let me know if I can help.

[KoditkarVedant]

I am seeing this error when I try to run docs locally

[joemcbride]

Not sure what that error means. Seems pretty generic.

Are you running on macOS or Windows?

Run gatsby info or gatsby info --clipboard in the gatsby project directory and paste its contents here.
Not working? You may need to update your global gatsby-cli - npm install -g gatsby-cli

Here’s a few people with the same issue:
gatsbyjs/gatsby#3183

[KoditkarVedant]

I am running on Windows. I will look into those options.