[Request]: Add/improve docs on shared state (shared stores, Context, shared signals, passing props)
还没有人认领这个 Issue。
- 主要语言
- MDX
- 星标
- 292
- 派生
- 361
- 平均合并
- 7 小时 51 分钟
- 30 天内合并 PR
- 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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先比较现有的 state-management 和 complex-state-management 页面,然后查看请求中链接的 Diátaxis 指南。当一个连贯的专用页面或页面组解释 shared stores、Context、shared signals 和传递 props,包括它们的权衡以及何时选择每一种方式时,即可视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100