[Request]: Add/improve docs on shared state (shared stores, Context, shared signals, passing props)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- documentation
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.
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
- Lenguaje dominante
- MDX
- Estrellas
- 292
- Forks
- 361
- Merge medio
- 7 h 51 min
- PR fusionados (30 d)
- 1
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de solidjs/solid-docs
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
solidjs/solid-docs#1635 ·
-
[Content]: Cloudflare Workers Abiertogood first issue solid solidstart
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
solidjs/solid-docs#1522 ·
-
pending review
solidjs/solid-docs#1637 · 1 asignado ·
-
help wanted
solidjs/solid-docs#1636 · 5 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
solidjs/solid-docs#1630 · 1 comentario ·
Todos los issues de solidjs/solid-docs
Issues similares
-
Area: Excel support
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
orbeon/orbeon-forms#7893 ·
-
Theme loads third-party resources on every page (jsdelivr web font, cdnjs Font Awesome) – GDPR Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comentario ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Claiming namespace: rasy007 Abiertonamespace operations
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
EclipseFdn/open-vsx.org#13419 ·