solidjs / solidjs/solid-docs

[Content]: Document Single-Flight Mutations + failures

Ouverte
#777 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

help wanted solid
Langage dominant
MDX
Étoiles
292
Forks
361
Merge moyen
7 h 51 min
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner la SolidStart 1.0 release announcement concernant le Single-Flight Mutations chart et comparez-la avec la section Actions de la Solid Router documentation. Définissez le périmètre de la nouvelle section de documentation autour de l'utilisation, des échecs des mutations et de la récupération des données, ainsi que de la relation entre les mutations et les Actions. La tâche est terminée lorsque les concepts pertinents, la gestion des échecs et la navigation entre les deux sections de documentation sont clairs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.