Skip to content
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.

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

[Content]: Problems with Data Loading documentation #861

Open
amirhhashemi opened this issue Aug 28, 2024 · 0 comments
Open

[Content]: Problems with Data Loading documentation #861

amirhhashemi opened this issue Aug 28, 2024 · 0 comments
Assignees
Labels
improve documentation Enhance existing documentation. pending review Awaiting review by team members.

Comments

@amirhhashemi
Copy link
Contributor

📚 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:

  • Using createResource with Suspense and ErrorBoundary
  • Implementing Tanstack Query
  • Demonstrating createAsync with actions

The proposed PR (#857) aims to address these issues.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@amirhhashemi amirhhashemi added improve documentation Enhance existing documentation. pending review Awaiting review by team members. labels Aug 28, 2024
@amirhhashemi amirhhashemi changed the title [Content]: [Content]: Problems with Data Loading documentation Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation. pending review Awaiting review by team members.
Projects
None yet
Development

No branches or pull requests

3 participants
@amirhhashemi @LadyBluenotes and others