Clarify distinction between single-user and multi-user sharing of signals
Nobody has claimed this yet.
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
https://github.com/vaadin/docs/blob/main/articles/flow/ui-state/shared-signals.adoc is confusing since the introduction is about the SharedXyzSignal types whereas some of the examples are for use cases that don't share state between users and should thus use ValueSignal instead. Furthermore, at least the SystemStatusSignal example is using ValueSignal even though it should probably use SharedValueSignal instead.
Contributor guide
No contributing guide indexed for this repository
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
Read articles/flow/ui-state/shared-signals.adoc, starting with its introduction and the examples that use SharedXyzSignal or ValueSignal. Check each example against whether state is shared between users, and correct the SystemStatusSignal example if it should use SharedValueSignal. Done means the introduction and examples consistently distinguish single-user from multi-user signal sharing.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100