[docs][guides] improve Schema Customization docs #31213
Replies: 4 comments
-
I can work on the Gatsby Style guide rules. I can try to add some more examples, but I am currently not experienced (yet) with all the ins and outs of the Schema Customization API. |
Beta Was this translation helpful? Give feedback.
-
Here are some materials that include a wealth of relevant information, particularly the context on "Why it was needed" and themes use cases: |
Beta Was this translation helpful? Give feedback.
-
Hi! I am a new contributor to Gatsby and this particular issue interests me a lot. May I begin working on this ticket to resolve the issue? |
Beta Was this translation helpful? Give feedback.
-
Hello @marcysutton, I would like to contribute to this issue |
Beta Was this translation helpful? Give feedback.
-
Summary
Through feedback, we've heard that the Schema Customization docs could use some improvement for understanding how to apply the concepts. For example:
The doc uses an example project, which is great. But it would be helpful to add some more ideas throughout the doc to help users understand how to apply the concepts to their own work (e.g. "One use case for this approach would be ______", "You might apply this to do ____", etc.)
This doc also needs to be updated to adhere to the Gatsby Style Guide, as it uses "our" and "we" instead of focusing on the reader with "you" and "your".
Motivation
We want users of all skill levels to feel more comfortable using Schema Customization. It's a powerful API that we aren't quite explaining in a way that people can understand -- therefore its usefulness is limited to more advanced users. In general, adding examples of why and how to use something are just as important as the explanation of what the thing is -- we've seen a similar situation with Gatsby Themes.
Related issues
Loosely related to #14228, which is more focused on Gatsby Internals.
Beta Was this translation helpful? Give feedback.
All reactions