[Content]: Problems with Data Loading documentation #861
Labels
improve documentation
Enhance existing documentation.
pending review
Awaiting review by team members.
📚 Subject area/topic
Data loading in SolidStart
📋 Page(s) affected (or suggested, for new content)
https://docs.solidjs.com/solid-start/building-your-application/data-loading
📋 Description of content that is out-of-date or incorrect
The Data Loading documentation has several areas for improvement:
Structure: The organization is counterintuitive, with only two main sections: "Data loading on the client" and "Data loading always on the server" (oddly, a subsection of the former). This structure doesn't effectively guide users through the various data loading methods.
Comparison: There's a lack of clear comparison between different data loading methods (
createAsync
,createResource
, and Tanstack Query). The documentation doesn't provide guidance on when to use each method.Depth: Some crucial concepts, like the
load
function, are inadequately explained. The documentation doesn't clearly outline when and how to use this function effectively.Examples: The documentation lacks comprehensive examples, particularly:
createResource
withSuspense
andErrorBoundary
createAsync
with actionsThe proposed PR (#857) aims to address these issues.
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)
No response
The text was updated successfully, but these errors were encountered: