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) Remove jsdoc for graphql fragments in GraphQL API #21811

Merged
merged 4 commits into from
Feb 28, 2020

Conversation

tesseralis
Copy link
Contributor

@tesseralis tesseralis commented Feb 28, 2020

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-image README.

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.

@tesseralis tesseralis requested a review from a team as a code owner February 28, 2020 01:59
@tesseralis tesseralis requested a review from a team as a code owner February 28, 2020 02:46
gillkyle
gillkyle previously approved these changes Feb 28, 2020
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Left one suggestion about a relative link is all 👍

packages/gatsby-image/README.md Outdated Show resolved Hide resolved
Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, and hooray for making it easier to translate all the things!

@gillkyle gillkyle added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Feb 28, 2020
@gillkyle gillkyle merged commit 068ef1b into master Feb 28, 2020
@gillkyle gillkyle deleted the graphql-api-refactor branch February 28, 2020 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants