solidjs / solidjs/solid-docs

[Request]: Add/improve docs on shared state (shared stores, Context, shared signals, passing props)

オープン
#540 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

help wanted solid
主要言語
MDX
スター
292
フォーク
361
平均マージ
7時間 51分
マージ済み PR(30日)
1

説明

What is this request related to?

Shared State (shared stores, Context, shared signals, passing props)

📋 Suggested

Most of the existing related pages for each particular tool I would want to leave as is, they do a good job explaining how to setup/use each tool.

I'd more be looking to add a new page or group of pages that focus on all of the different ways to create and use shared state, the tradeoffs of each, and when/why you would want to use each.

https://docs.solidjs.com/guides/state-management and https://docs.solidjs.com/guides/complex-state-management go into some of this but not to the extent I think it should be. It also is broken up between the 2 making it feel disconnected and never fully goes into Context.

I'm also not sure that the Guides section makes the most sense for this since it is more about understanding the tools than it is about accomplishing a specific goal.

In the https://diataxis.fr/ site that provides the framework for documentation it describes How-to Guides as directions that guide the reader through a problem or towards a result. It focuses on step by step directions to perform a particular task while the user is "at work", which doesn't feel right as a way to introduce these concepts/tools and compare and contrast them.

📋 General description or bullet points

Currently the content for shared state either is missing or is spread out across many other pages/groups of the docs. With this being a very important topic I feel like there should be a dedicated page or group of pages that covers the various ways to create shared state and explanations of the benefits/restrictions of each so people can get a clear idea of when and why they might want to use each.

I personally found it very difficult to understand when and why I would want to use Context rather than just a shared store. After chatting with some people in the discord I learned why, but the info often wasn't in the docs. You could find some of it if you went digging in several places, but those places currently focus more on what each thing is and how to use it so you still need to figure out on your own how they compare to each other and some nuances of why each is most beneficial for certain situations.

I think this leads to people not have a clear understanding of the set of tools solid provides and which tool would be best suited to their problem.

🖥️ Reproduction of code samples in StackBlitz

No response

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず既存の state-management ページと complex-state-management ページを比較し、次にリクエストにリンクされている Diátaxis のガイダンスを確認してください。共有ストア、Context、共有 signals、props の受け渡しについて、それぞれのトレードオフとどのような場合に選択すべきかを含めて、一貫性のある専用ページまたはページグループで説明できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript
領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。