-
Notifications
You must be signed in to change notification settings - Fork 327
Improve data fetching docs #1179
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
Merged
LadyBluenotes
merged 36 commits into
solidjs:v2-docs
from
amirhhashemi:fix-use-submission-situation
Aug 26, 2025
Merged
Improve data fetching docs #1179
LadyBluenotes
merged 36 commits into
solidjs:v2-docs
from
amirhhashemi:fix-use-submission-situation
Aug 26, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
❌ Deploy Preview for solid-docs failed. Why did it fail? →
|
2 tasks
42fee24
to
fbdec7a
Compare
fbdec7a
to
73da3ce
Compare
LadyBluenotes
requested changes
Aug 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you did a wonderful job! Most of what I've suggested are just structure errors but the overall content is a massive improvement.
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
Co-authored-by: Sarah <[email protected]>
LadyBluenotes
approved these changes
Aug 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR completely overhauls the data fetching documentation in Solid Router and SolidStart.
Summary
Solid Router
useSubmission
,useSubmissions
,action
,useAction
,query
,createAsync
,createAsyncStore
, andpreload
have been updated to improve compliance with Diataxis and enhance accuracy and completeness.SolidStart
Proposals and trade-offs
Two proposals were initially considered for this PR. However, during the writing process, I decided not to implement them for the following reasons:
Data fetching and data mutation how-to guide in Solid Router: The updated data fetching and data mutation pages in the Solid Router documentation already provide practical examples for most common tasks. I did not see the value in creating a separate page that merely rephrases these examples in a how-to format. If a compelling use case is suggested, I would be open to creating this page.
A comprehensive data fetching explanation page for SolidStart: This proposal recommended a data fetching explanation page that would cover Solid and Solid Router data-fetching mechanisms. However, since the Solid Router documentation already contains a comprehensive explanation, I saw no reason to duplicate content. Instead, I encouraged users to refer to the Solid Router documentation, and focused on the unique features of SolidStart, such as server functions and single-flight mutations.
Related issues & labels
useSubmission
&useSubmissions
#1026, [Content]: ClarifyuseSubmission(s)
Documentation to Emphasize Actions Over Form Submissions #1024, [Content]: Remove the useSubmission/useSubmissions section in theaction
reference #1003, [Content]: Confusing language for useAction #1192, Proper Usage of action and with Method in Solid Router #791, Server Action: Link to benefits from API Reference #981, [Content]: the preload explanation about cache is very vague How much time does it cache the route or is this only caching the route data not the route itself as after render #1173, [Content]: Clarify howquery
cache works #1204