matrix-org / matrix-org/matrix-spec
The spec doesn't define peeking
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://spec.matrix.org/v1.7/client-server-api/#room-previews
**Issue**
The spec mentions "peeking" several times in the C-S API, but it never really defines what peeking is. https://spec.matrix.org/v1.7/client-server-api/#room-previews mentions "lurking" but not peeking.
I suggest adding the text in bold:
> It is sometimes desirable to offer a preview of a room, where a user can “lurk” and read messages posted to the room, without joining the room. **This behaviour is sometimes referred to as "peeking"**.
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
Open the Client-Server API room previews section at the linked specification URL and review the surrounding wording for consistency. Add the proposed definition of “peeking,” then verify that the section clearly explains the term without changing its existing description of lurking.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100