Documentation - Githubissues

vadistic / graphql-extra

GraphQL AST/SDL toolkit extending graphql/graphql-js with extra features for code generation & testing

https://graphql-extra.netlify.com/globals

MIT License

15 stars 3 forks source link

Documentation #5

Open vadistic opened 4 years ago

vadistic commented 4 years ago

Opening this issue to document progress on documentation.

This project contains way more code than words and this should be amended :)

The project main goals are:

[ ] flexible code first graphql SDL
[ ] abstracting tested boilerplate for various codegens
[ ] utility set for testing graphql stuff

And there are few conceptual modules:

[ ] code-first ast creation
[ ] mixins/apis for mutation of AST nodes
[ ] hooks/utils on which apis are build
[ ] hight level helpers (that are not quite there yet)

All those were meant to be quite composable and I should probably provide few patterns of what could be done with it :)

For docs site - except autogenerated typedoc - https://codedoc.cc/ looks nice.