solidjs / solidjs/solid-docs

[Content]: Core concepts are referenced but not explained fully/clearly (tracked/reactive scopes and ownership)

Open
#544 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted solid
Dominant language
MDX
Stars
292
Forks
361
Avg merge
7h 51m
Merged PRs (30d)
1

Description

📚 Subject area/topic

Tracking scopes and ownership

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/concepts/intro-to-reactivity#tracking-changes

And anywhere that mentions something like "signals must be accessed within a tracked/reactive scope"

https://docs.solidjs.com/reference/reactive-utilities/create-root

https://docs.solidjs.com/reference/reactive-utilities/get-owner

https://docs.solidjs.com/reference/reactive-utilities/run-with-owner

📋 Description of content that is out-of-date or incorrect

There are important concepts in solid like the idea of tracked/reactive scope or ownership that are mentioned but there isn't a place that clearly explains them.

Tracked/Reactive Scope

Signal updates will only be reacted to if they are accessed in a reactive or tracked scope, however I don't think there is a place that clearly outlines what all of the reactive scopes are.

Many examples just say to use createEffect or imply that JSX is a reactive scope but there isn't a place that goes through all of them or explains why the JSX template is a reactive scope.

  • all of the different effects/computations
  • createRoot (I don't fully understand how this works but in the OG docs it says the render function uses this to create the tracked scope for the app)
Owners
  • What is an owner?
  • What does it do?
  • How does ownership work in solid?
  • Why are they important?
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the tracking-changes section and the create-root, get-owner, and run-with-owner reference pages. Map where tracked/reactive scopes and ownership are currently mentioned, then document what they are, how they work, and why they matter, including the listed effects, computations, and JSX behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.