Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spec for MSC2867 (Marking rooms as unread) #1895

Merged
merged 7 commits into from
Jul 15, 2024

Conversation

Johennes
Copy link
Contributor

@Johennes Johennes commented Jul 1, 2024

Per MSC2867 (markdown)

Relates to: matrix-org/matrix-spec-proposals#2867
Signed-off-by: Johannes Marbach n0-0ne+github@mailbox.org

Pull Request Checklist

Preview: https://pr1895--matrix-spec-previews.netlify.app

Relates to: matrix-org/matrix-spec-proposals#2867
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
@Johennes
Copy link
Contributor Author

Johennes commented Jul 1, 2024

This currently generalizes the "Fully read markers" module to include read and unread markers because there are some shared semantics between these two. I'm curious if folks think this is a good idea. If not, the added subsections are easily moved to their own module.

Unlike for read markers, the MSC doesn't specify any API for unread markers. I assume this is because for unread markers there is no use case for performing any other actions (such as setting read receipts) simultaneously. Consequently, I haven't added any new CS endpoints here.

The MSC goes into quite a bit of detail around the UI treatment of unread rooms with red badges. I have interpreted this as an example and left the concrete UI treatment as an implementation detail in the spec.

@Johennes Johennes marked this pull request as ready for review July 1, 2024 18:52
@Johennes Johennes requested a review from a team as a code owner July 1, 2024 18:52
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor wording tweaks, otherwise this LGTM!

This currently generalizes the "Fully read markers" module to include read and unread markers because there are some shared semantics between these two. I'm curious if folks think this is a good idea. If not, the added subsections are easily moved to their own module.

While you can easily implement one without the other, I think combining the two makes sense, as they are closely related concepts.

content/client-server-api/modules/read_markers.md Outdated Show resolved Hide resolved
content/client-server-api/modules/read_markers.md Outdated Show resolved Hide resolved
content/client-server-api/modules/read_markers.md Outdated Show resolved Hide resolved
content/client-server-api/modules/read_markers.md Outdated Show resolved Hide resolved
Johennes and others added 4 commits July 10, 2024 10:04
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
@anoadragon453
Copy link
Member

Thank you!

@anoadragon453 anoadragon453 merged commit cbe8092 into matrix-org:main Jul 15, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants