matrix-org / matrix-org/matrix-spec

Clarify which events come down on which keys in /sync (SPEC-297)

Open
#136 0 comments 0 reactions 0 assignees View on GitHub
A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Submitted by @​kegan:matrix.org
At the moment things like the ephemeral block have an unhelpful description just saying that typing is something that can appear in that block. We should explicitly state which events go where or provide a way to deduce them based on the kind of event and then explain the steps you perform to work it out

(Imported from https://matrix.org/jira/browse/SPEC-297)

Contributor guide

Open the contributing guide

Research direction

Start with the /sync section of the Matrix protocol specification and review the description of the ephemeral block. Document which event types appear on each key, or explain how to derive their placement from the event kind; done means the mapping or deduction steps are explicit.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.