Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
JasonHassold opened this issue Feb 25, 2024 · 0 comments
Assignees
Labels
improve documentation Enhance existing documentation.

Comments

@JasonHassold
Copy link
Contributor

JasonHassold commented Feb 25, 2024

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

@JasonHassold JasonHassold added the pending review Awaiting review by team members. label Feb 25, 2024
@LadyBluenotes LadyBluenotes added improve documentation Enhance existing documentation. and removed pending review Awaiting review by team members. labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation.
Projects
None yet
Development

No branches or pull requests

3 participants