solidjs / solidjs/solid-docs

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

Đang mở
#540 0 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

help wanted solid
Ngôn ngữ chính
MDX
Star
292
Fork
361
Merge trung bình
7 giờ 51 phút
Pull request đã merge (30 ngày)
1

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các trang state-management và complex-state-management hiện có, sau đó xem lại hướng dẫn Diátaxis được liên kết trong yêu cầu. Công việc được xem là hoàn tất khi một trang hoặc nhóm trang chuyên biệt, nhất quán giải thích về shared stores, Context, shared signals và việc truyền props, bao gồm các đánh đổi của chúng và khi nào nên chọn từng cách.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.