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

Create inline types documentation #14212

Closed
m-allanson opened this issue May 21, 2019 · 3 comments
Closed

Create inline types documentation #14212

m-allanson opened this issue May 21, 2019 · 3 comments
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

Comments

@m-allanson
Copy link
Contributor

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 a phpinfo() 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 under gatsby 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.

@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label May 21, 2019
@m-allanson
Copy link
Contributor Author

It seems like a lot of the value of this could be gained by implementing #11602

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Jun 11, 2019
@gatsbot
Copy link

gatsbot bot commented Jun 11, 2019

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contributefor more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@gatsbot
Copy link

gatsbot bot commented Jun 22, 2019

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community!

@gatsbot gatsbot bot closed this as completed Jun 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant