Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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.

Sign up for GitHub

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

Jump to bottom

[docs] Continue to flesh out gatsby-node api functions descriptions #12665

Closed
lannonbr opened this issue Mar 19, 2019 · 1 comment
Closed

[docs] Continue to flesh out gatsby-node api functions descriptions #12665

lannonbr opened this issue Mar 19, 2019 · 1 comment
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@lannonbr
Copy link
Contributor

Summary

We have currently documented each of the various Node APIs here: https://www.gatsbyjs.org/docs/node-apis

That said, a large portion of them are just the name and a small description of it. What would be useful would be to add further context about each one that can include things like

  • Parameters specific to this API
  • an example of using the API

Basic example

the onCreateWebpackConfig API is a good example to describe what the API is, what params are passed in, and an example of using it.

https://www.gatsbyjs.org/docs/node-apis/#onCreateWebpackConfig
Screen Shot 2019-03-19 at 9 47 50 AM
@gatsbot gatsbot bot added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 19, 2019
@gillkyle gillkyle changed the title docs: Continue to flesh out gatsby-node api functions descriptions [docs] Continue to flesh out gatsby-node api functions descriptions Jun 13, 2019
@marcysutton marcysutton added the help wanted Issue with a clear description that the community can help with. label Jun 25, 2019
@sampittko
Copy link
Contributor

I would like to document onCreatePage API, should I create another issue referencing this one but more specific?

@sampittko sampittko mentioned this issue Oct 16, 2020
Merged
@LekoArts LekoArts closed this as completed May 4, 2021
@gatsbyjs gatsbyjs locked and limited conversation to collaborators May 4, 2021
@LekoArts LekoArts removed the not stale label May 7, 2021

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Assignees
No one assigned
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@danabrit @marcysutton @lannonbr @sidharthachatterjee @marisamorby @LekoArts @sampittko