[Content]: Document Single-Flight Mutations + failures
まだ誰も着手していません。
- 主要言語
- MDX
- スター
- 292
- フォーク
- 361
- 平均マージ
- 7時間 51分
- マージ済み PR(30日)
- 1
説明
📚 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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Single-Flight Mutations chart に関する SolidStart 1.0 release announcement を確認し、Solid Router documentation の Actions section と比較します。新しいドキュメントセクションの範囲を、使用方法、mutation と data-fetch の失敗、および mutation と actions の関係を中心に定義します。関連する概念、失敗処理、および2つのドキュメント領域間のナビゲーションが明確になっていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100