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

chore(docs): gatsby image - code block langue, fix snippets, fences a… #28934

Closed
wants to merge 3 commits into from

Conversation

muescha
Copy link
Contributor

@muescha muescha commented Jan 8, 2021

Description

changes:

  • code block language to jsx
  • fix snippets (close <Img /> tags, add import for Img
  • code fences around constants and names

Documentation

Related Issues

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jan 8, 2021
@LekoArts LekoArts added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jan 11, 2021
@ascorbic
Copy link
Contributor

Hi @muescha ,
Thanks for your help. I'll accept this, but bear in mind that we're rewriting all of the docs for these, so I wouldn't put more time into them right now.

// ⚠️ Doesn't work

({ logo }) => <Img src={logo}>
import React from "react"
import Img from "gatsby-image"
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not correct. The component is StaticImage from "gatsby-plugin-image"

@ascorbic
Copy link
Contributor

OK, after reviewing I'm afraid I'm not going to merge it. There are a number of mistakes in the changes, as well as other outdated information in the old docs. I am going to update this with the new, correct docs soon. Thanks again for your help, but I'd hold off on working on this plugin until it's stable

@ascorbic ascorbic closed this Jan 11, 2021
@muescha
Copy link
Contributor Author

muescha commented Jan 14, 2021

ok - i wait until stable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants