Create inline types documentation #14212
Labels
stale?
Issue that may be closed soon due to the original author not responding any more.
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
Summary
It can be difficult to know what GraphQL types are available in your Gatsby site. GraphQL can help with this!
Let's create a readonly resource that documents all the types running in your site, this resource should be available while running
gatsby develop
. This would be aphpinfo()
style page that describes everything you can use in your site, based on your site's plugins and config.It would be complimentary to the existing
/___graphql
page, and could contain links straight through the the___graphql
page.There should be a link to the page from the existing
___graphql
page.Basic example
This would add a new page (like
/___docs
) to any site running undergatsby develop
. The page would document the types available to your site, based on the schema that's been created.Motivation
This makes it easier to know what functionality is available in your site.
The text was updated successfully, but these errors were encountered: