Signals documentation: mention/explain `signal()` and `computed()`
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
In the signals documentation, it should be mentioned that signal() is an alias for new Signal.State() and computed() is an alias for new Signal.Computed().
In the current version, signal() gets used but is never explained, and computed() is never mentioned.
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.
Research direction
Locate the signals documentation and read the sections where signal() is already used. Update it to explain that signal() aliases new Signal.State() and that computed() aliases new Signal.Computed(), and confirm both functions are mentioned and explained.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100