matrix-org / matrix-org/matrix-spec

Spec mentions the "event stream" in a few places, which isn't clearly defined.

Open
#1,470 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

I believe it's making reference to https://spec.matrix.org/v1.6/client-server-api/#events, but since it's not really called out more than a casual mention in a paragraph it's easily missed.

We reference the "event stream" in a ton of places without any hyperlinks to it, so I'm fairly sure most people are going to miss this on the first readthrough.

It's also inconsistently called either an "events stream" or "event stream" because it wasn't hard enough to find already.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the specification source for every occurrence of “event stream” and “events stream,” then compare each usage with the linked Client-Server and Application Service API sections. Done means the terminology is consistent and the relevant references link clearly to the appropriate sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.