Document untrack behavior with uninitialized async reads (NotReady propagation)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start with the untrack reference page linked in the issue and review the async-read behavior described there alongside the solidjs/solid#3007 context. Update the page to distinguish dependency tracking from NotReady settlement, explain the owner’s suspension and rerun, and show a genuinely non-suspending readiness check using isPending/latest.
Written by the indexing model from the issue text.
Description
From solidjs/solid#3007 (reported by @mizulu).
The untrack reference page (https://v2.solidjs.com/reference/solid-js/reactivity/untrack) should document how untrack interacts with async reads in 2.0:
untrackstops dependency tracking — reads inside it do not subscribe the surrounding computation.- It does not opt out of async settlement. Reading an async source that is not yet ready inside
untrackstill throwsNotReadyError, which propagates to the owning computation: the owner suspends (participates inLoadingboundaries) and re-runs once the source first resolves.
In other words, untrack(() => getColor()) where getColor is a pending async memo will still cause the owner to re-run when getColor first settles — the read is untracked, but the not-ready suspension is part of async graph resolution, not tracking.
The page should spell out this distinction (tracking vs. settlement) and show the pattern for a genuinely non-suspending read of a possibly-pending source (e.g. checking readiness with isPending/latest as appropriate) so users aren't surprised that untrack alone doesn't provide a fallback-value escape hatch. A fallback-value overload for untrack was considered in solidjs/solid#3007 and rejected — the docs are the fix.
- Dominant language
- MDX
- Stars
- 292
- Forks
- 361
- Avg merge
- 7h 51m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from solidjs/solid-docs
-
good first issue solid solidstart
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
solidjs/solid-docs#1522 ·
-
pending review
solidjs/solid-docs#1637 · 1 assignee ·
-
pending review
solidjs/solid-docs#1636 · 1 comment · 1 assignee ·
-
Difficulty 3/5 1-2 days Newbie friendliness 52/100
solidjs/solid-docs#1630 · 1 comment ·
-
help wanted
solidjs/solid-docs#1593 · 4 comments · 2 reactions · 1 assignee ·
All issues in solidjs/solid-docs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100