solidjs / solidjs/solid-docs

[Content]: Document Single-Flight Mutations + failures

Open
#777 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted solid
Dominant language
MDX
Stars
292
Forks
361
Avg merge
7h 51m
Merged PRs (30d)
1

Description

๐Ÿ“š Subject area/topic

SolidStart Single-Flight Mutations

๐Ÿ“‹ Page(s) affected (or suggested, for new content)

New section rquired

๐Ÿ“‹ Description of content that is out-of-date or incorrect

It would be useful and important to add documentation for Single-Flight Mutations. This doesn't seem to be documented anywhere. It should include:

  • A description of what it is and how to use it
  • An Eraser chart of how mutations actually work (look at SolidStart 1.0 release announcement for a sample)
  • How to handle failures

Regarding the last point, this came up in a conversation recently in Start Team chat:

From what I understand, if the mutation (action) fails then you handle that as normal, whether by catching the error or using submission state. If one of the data fetches fail then that'll be reflected by whatever createAsync is consuming the data fetch, since SFM just inserts the promise returned by cache on the server into the cache on the client

What's also confusing is the fact that there's an Action section in the router docs however it's unclear how it's related to SFMs. It's slightly confusing that actions are described in router outside of Start as well.

I'm wondering if it's necessary to create a section describing mutations and ensure that users know how to find their way to actions? Perhaps this is a separate issue entirely? I don't see this requested/discussed in other topics so I'll pose it here for now.

๐Ÿ–ฅ๏ธ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up โ€” it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the SolidStart 1.0 release announcement for its Single-Flight Mutations chart and compare it with the Solid Router documentation's Actions section. Define the new documentation section's scope around usage, mutation and data-fetch failures, and the relationship between mutations and actions. Done means the relevant concepts, failure handling, and navigation between the two documentation areas are clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.