docs: remove TODOs from Static vs Normal Queries to focus more on internals #19219
Conversation
gillkyle
added
the
type: documentation
Co-Authored-By: Michael <[email protected]>
There was a problem hiding this comment.
Great start to this one! I think the best way to move it forward would be to pair with someone on the core team and walk through the code. This PR does remove TODOs which is helpful, but the explanations are still pretty confusing and don't tell much of a story about what's happening in the code. What is the purpose of some of these methods? What would happen if this code didn't exist?
|
Just updated the PR to tell more of a story of the code like Marcy suggested, as well as removed a couple lines that me and @sidharthachatterjee didn't think really provide much new context or insight. Added some more code snippets to showcase the idea of what's changing in your code being built as well. |
gillkyle
changed the title
|
I love having an explanation for this! These are really good examples and clarifications. Think this post will have a big impact on removing some of the gatsby magic! |
Co-Authored-By: LB <[email protected]>
|
Note: all links in docs for query-runner has changed and now a 404. I created a follow up issue #19557 to decouple it from this PR |
Co-Authored-By: LB <[email protected]>
|
Looks great @gillkyle 🎉 |
Description
This doc had several TODO's hanging around, there was redundant information around the differences in usage between this doc and the using static query components doc, so I removed it from this section and tried to refocus it more on Gatsby internals.
I answered what I felt I could discern from reading code in the query-watcher, query-runner, and query-compilation files, but if someone from the Core team has more context and can help realign something it would be very appreciated 😬
Related Issues
Closes #15157