Graphql-flutter: A static website for documentation
I think this project deserves some static website for documentation and showcase some use case at the current state. I could volunteer to this at the moment.
juicycleff
All 13 comments
Yes definitely something we need in the future. I鈥檓 re writing most of the internals, and made a load of breaking changes, so it might be best to start on the documentation once the api is more solid. What do you think?
HofmannZ
on 20 Aug 2018
Alright thats better, I will be waiting for that. Meanwhile thumbs up guys.
juicycleff
on 22 Aug 2018
@juicycleff Just finished the major API changes. We can start working on some docs.
To try it out use version 1.0.0-alpha.3 of this package.
HofmannZ
on 2 Sep 2018
@HofmannZ Sorry I was away and busy. I want to start the docs now. Btw I noticed development has been halted, is this permanent or temporary?
juicycleff
on 8 Feb 2019
@juicycleff Feel free to start working on the docs.
eusdima
on 16 Feb 2019
The idiomatic thing to do here is probably to use dartdoc. I think this is especially important as the contributor pool expands and we need to communicate the intent of code internals more robustly
micimize
on 26 Mar 2019
@micimize i like the concept by the dartdoc tool, it will make it easier to keep the docs is up to to date. I will start exploring this over the weekend. May be soon we can have a docs site.
mainawycliffe
on 28 Jun 2019
@HofmannZ I see you are assigned this issues, any progress?
mainawycliffe
on 28 Jun 2019
Can't we use https://pub.dev/documentation/graphql/latest/graphql/graphql-library.html ? Inline doc generated by pub.dev is also widely used by Flutter 1st party plugin.
Otherwise, we can make use of Flutter web, github and netlify for a static website.
truongsinh
on 3 Jul 2019
The dartdoc tool suggested above does the same thing, but allows you to add extra markdown documentation. But to be honest, this kind of documentation are good for advanced users but not beginners.
Flutter for web would be a mess, it would be the same using Angular or React to create a docs site, its possible it just not suitable. What we need is a Static Site Generator like Hugo or Gatsby which allows for easy content management using Markdown, easy themming and generates a static site that can be hosted anywhere like GitHub Pages or Netlify. Most open source project i have come across use a variation of this.
mainawycliffe
on 3 Jul 2019
I believe inline doc / https://pub.dev/documentation can also have markdown, even code snippet.
truongsinh
on 3 Jul 2019
I would much prefer this style of docs https://felangel.github.io/bloc/#/, with recipes and clear cut documentation that is easy to read for all developers. Then we can link to the API Reference for someone interested in digging into the APIs - and this already exist on pub.dev, just a simple link to the API reference.
mainawycliffe
on 3 Jul 2019
merging into #741
micimize
on 7 Oct 2020
Related issues
DrBanner97
路
13Comments
nkwwk
路
20Comments
micimize
路
16Comments
Kyle-Mendes
路
15Comments
eliezedeck
路
13Comments
Most helpful comment
I would much prefer this style of docs https://felangel.github.io/bloc/#/, with recipes and clear cut documentation that is easy to read for all developers. Then we can link to the API Reference for someone interested in digging into the APIs - and this already exist on pub.dev, just a simple link to the API reference.