add documention for `@graphiql/react`

[thomasheyenbrock]

This adds some more documentation in the simplest form possible: JSDoc comments :D Those should also be picked up by typedoc and enhance the docs we generate and push to Netlify already.

TODOs:

• [x] write README for @graphiql/react

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 773e17509fb6519130a049e5d76c504ac82feabd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@graphiql/react	Minor
graphiql	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codecov[bot]]

Codecov Report

:exclamation: No coverage uploaded for pull request base (graphiql-v2@adae306). Click here to learn what that means. The diff coverage is n/a.

@@              Coverage Diff               @@
##             graphiql-v2    #2657   +/-   ##
==============================================
  Coverage               ?   58.43%           
==============================================
  Files                  ?       92           
  Lines                  ?     5331           
  Branches               ?     1758           
==============================================
  Hits                   ?     3115           
  Misses                 ?     2195           
  Partials               ?       21           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[acao]

Love it!

I need to fix the typedoc config, but this is looking really nice! Of course it will be great in vscode/codesandbox/etc but also:

https://deploy-preview-2657--graphiql-test.netlify.app/typedoc/modules/graphiql_react.html#editorcontextproviderprops-5

i love these kinds of docs improvements because they show up everywhere and we can make them show up in even more places!

would be cool to add @examples using backtick codeblocks, and then perhaps we can do some fun things with with a doc site tool like docusaurus or what have you - mdx, plugins, etc to link to show inline examples that link to templated codesandboxes for examples/etc

perhaps you'll want to keep the examples to the readme for now, whatever you prefer!

Edit: looks like we just need to ignore the .d.ts files, or ignore everything but, to get rid of the duplicates!