solidjs / solidjs/solid-docs

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

Abierto
#540 0 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

help wanted solid
Lenguaje dominante
MDX
Estrellas
292
Forks
361
Merge medio
7 h 51 min
PR fusionados (30 d)
1

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Empieza comparando las páginas existentes state-management y complex-state-management, y luego revisa las directrices de Diátaxis enlazadas en la solicitud. Se considera terminado cuando una página o grupo de páginas dedicado y coherente explique los stores compartidos, Context, las signals compartidas y el paso de props, incluidos sus compromisos y cuándo elegir cada opción.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.