Skip to content

Conversation

amirhhashemi
Copy link
Collaborator

@amirhhashemi amirhhashemi commented May 16, 2025

  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description

This PR completely overhauls the data fetching documentation in Solid Router and SolidStart.

Summary

Solid Router

  • The actions explanation page has been completely rewritten to include topics such as optimistic UI, error handling, revalidation behavior, and streaming.
  • A new queries explanation page has been added.
  • Reference pages for useSubmission, useSubmissions, action, useAction, query, createAsync, createAsyncStore, and preload have been updated to improve compliance with Diataxis and enhance accuracy and completeness.

SolidStart

  • The data loading explanation page has been renamed to "data fetching" for better consistency.
  • The data fetching explanation page has been updated.
  • A new data mutation explanation page has been added.
  • The data fetching how-to page has been updated to remove redundant content in the introduction.

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

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

netlify bot commented May 16, 2025

Deploy Preview for solid-docs failed. Why did it fail? →

Name Link
🔨 Latest commit 0eff6f4
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/68ac1676b5a50800082c62e5

@amirhhashemi amirhhashemi force-pushed the fix-use-submission-situation branch from 42fee24 to fbdec7a Compare July 30, 2025 04:01
@amirhhashemi amirhhashemi force-pushed the fix-use-submission-situation branch from fbdec7a to 73da3ce Compare July 30, 2025 04:02
@amirhhashemi amirhhashemi changed the title Fix useSubmission/useSubmissions and action docs Improve data fetching docs Aug 23, 2025
@amirhhashemi amirhhashemi marked this pull request as ready for review August 25, 2025 05:43
Copy link
Member

@LadyBluenotes LadyBluenotes left a 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.

@LadyBluenotes LadyBluenotes changed the base branch from main to v2-docs August 25, 2025 19:39
amirhhashemi and others added 15 commits August 26, 2025 07:15
@LadyBluenotes LadyBluenotes merged commit 780750c into solidjs:v2-docs Aug 26, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Content]: Guide containing useSubmission & useSubmissions
2 participants