sikanhe / gqtx

Code-first Typescript GraphQL Server without codegen or metaprogramming
458 stars 13 forks source link

docs: initial documentation #44

Closed FedericoBiccheddu closed 6 months ago

FedericoBiccheddu commented 3 years ago

I think this could be a nice addition to this project mostly because:

There are some points that need to be discussed before an eventual release:

Todo:


I created a preview of my branch on Vercel in order to have an idea of the final result: https://gqtx.vercel.app/

FedericoBiccheddu commented 3 years ago

Added Introductions to object types and objectType documentation.

Feedback are much appreciated (mostly my english :laughing:).

FedericoBiccheddu commented 3 years ago

IMO examples are way to verbose. Docusaurus does not support folding sections for now (see docusaurus/2215) to fold repetitive code but leaving a way to copy the example code.

I'm thinking about an interactive Playground on CodeSandbox to solve this problem, but I don't know if it is better to create a sandbox for each example or a fully functional project with every gqtx feature.

What are your thoughts? Maybe is better to track this in another issue to gather feedbacks?