Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: initial documentation #44

Closed
wants to merge 6 commits into from
Closed

docs: initial documentation #44

wants to merge 6 commits into from

Conversation

FedericoBiccheddu
Copy link
Contributor

@FedericoBiccheddu FedericoBiccheddu commented Feb 28, 2021

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

  • There are some nice features coming in the next release
  • Could improve library adoption by making easier to work with gqtx without digging into source files and those types for basic usage
  • In the future might be needed to have major versions with different behaviour and docs help documenting that

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

  • Choose the provider for deploying the docs (GitHub Pages? Vercel? Netlify?)
  • Maybe use an organization and move the docs in another repo to keep this repo lean?
  • What pages are required before publishing the docs

Todo:

  • Add custom css to hightlight code lines
  • Expand by default every sidebar section

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

@FedericoBiccheddu
Copy link
Contributor Author

FedericoBiccheddu commented Apr 6, 2021

Added Introductions to object types and objectType documentation.

Feedback are much appreciated (mostly my english 😆).

@FedericoBiccheddu
Copy link
Contributor Author

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?

@FedericoBiccheddu FedericoBiccheddu closed this by deleting the head repository Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant