GraphQLBundle
GraphQLBundle copied to clipboard
overblog
Proper documentation website
It would be great to create a dedicated website for the documentation (with tutorials, cookbook, ..). Maybe using Github pages? Maybe with a nice logo?
So I did install it and it is very nice. I started to integrate the current documentation in it. Where should we host the documentation generator? The output will be stored as a Github pages within this repository, but what about the generator itself? @mcg-web would you mind to add a repository under the Overblog organisation for it?
A couple of months ago I was searching for the documentation framework and stumbled upon the Docusaurus. I already planned to integrate it, but since you do it, then fine. The main reason, why I like this framework is its support of multi-language code blocks, which means we can finally unify the code examples for Annotations, Attributes, YAML and GraphQL SDL. And Docusaurus supports all these syntaxes.
Besides that it works on React and uses Markdown. It fits perfectly.
I suggest you to bring the new documentation site alive and the further content management you can leave to me. As for the logo I don't know. I would leave it to a designer.
So, I set the repository here: https://github.com/Vincz/graphql-bundle-documentation You both (@mcg-web & @murtukov) should have access to it. I did create a new issue (https://github.com/overblog/GraphQLBundle/issues/809) to have a TODO about what we need to do. The most urgent is to define the documentation hierarchy.