solidjs / solidjs/solid-docs

[Content]: Document Single-Flight Mutations + failures

Aperta
#777 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

help wanted solid
Lingua principale
MDX
Stelle
292
Fork
361
Merge medio
7h 51m
PR unite (30g)
1

Descrizione

📚 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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando la SolidStart 1.0 release announcement relativa al Single-Flight Mutations chart e confrontala con la sezione Actions della Solid Router documentation. Definisci l'ambito della nuova sezione della documentazione incentrandolo sull'utilizzo, sui fallimenti delle mutation e del recupero dei dati e sulla relazione tra mutation e actions. Il lavoro è completato quando i concetti rilevanti, la gestione dei fallimenti e la navigazione tra le due aree della documentazione sono chiari.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.