This issue was moved to a discussion.
You can continue the conversation there. Go to discussion →
[docs][guides] better document Gatsby GraphQL APIs #15231
Labels
topic: GraphQL
Related to Gatsby's GraphQL layer
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
Summary
As part of #13708, GraphQL is a key workflow we want to visit to clear up common learning barriers and improve troubleshooting. In addition to "Querying Data" recipes, GraphQL APIs in Gatsby could be better documented all around. Things like:
sort
,limit
, etc.Making these APIs easy to find and more scannable/digestible would be a huge improvement. Further, in feedback from Gatsbyjs.org, there were these comments in reference to the Querying Data in pages doc:
Adding some pages to the Gatsby API section would help surface these details without having to guess what page they're on; i.e. "Understanding GraphQL Syntax" isn't an intuitive place to look for API docs. The Reference Guide pages could stick around, and link to these new API docs.
There was also this comment regarding the Querying with GraphQL doc, which further supports this API doc direction:
I'm keeping this inkteam-assigned for now so we can take a close look at this in @gatsbyjs/learning, as an FYI.
The text was updated successfully, but these errors were encountered: