(docs) Remove jsdoc for graphql fragments in GraphQL API #21811
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gillkyle
previously approved these changes
Feb 28, 2020
Co-Authored-By: Kyle Gill <[email protected]>
gillkyle
approved these changes
Feb 28, 2020
gillkyle
added
the
bot: merge on green
This was referenced Mar 17, 2020
This was referenced Jul 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Following the discussion here: #21536 (comment)
We've decided to just remove the API docs and move the content to where they're actually referenced, in the
gatsby-imageREADME.Related PRs
Alternative of #21536.
Further work
I do think that further work needs to be done here in order to clarify how to use Gatsby Image. The information is split up between the Gatsby Image API, the gatsby-image README, and the reference guides for using images in Gatsby, and I'm having trouble figuring out where's the right place to put information in each. For now, the main goal is to unblock being able to pull in translations of this file.