Skip to content

docs(bookmarks): add message bookmarks feature documentation #13

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.

Sign up for GitHub

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

Draft
Just-Insane wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(bookmarks): add message bookmarks feature documentation #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/features/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ This section covers the features and improvements that have been added to Sable
- [UI Improvements](ui-improvements) — A collection of quality-of-life improvements across the whole app.
- [Presence](presence) — Control whether your online/away status is shared with others.
- [Developer Tools](developer-tools) — Internal debug log viewer and in-app bug report command.
- [Message Bookmarks](bookmarks) — Save messages for later and access them from the bookmarks sidebar page, synced across devices. *(Experimental — MSC4438)*
37 changes: 37 additions & 0 deletions content/features/bookmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
+++
title = "Message Bookmarks"
weight = 10
+++

> **Experimental feature** — Enable via **Settings → Experimental → Message Bookmarks (MSC4438)**.

Bookmarks let you save individual messages for later reference. Saved bookmarks appear in a dedicated **Bookmarks** page in the sidebar and sync automatically across all your devices.

This feature implements [MSC4438](https://github.com/matrix-org/matrix-spec-proposals/pull/4438). See the [tracking issue](https://github.com/SableClient/Sable/issues/600) for known limitations and progress.

# Bookmarking a Message

Hover over any message and open the message menu (the **⋮** button). Select **Bookmark Message**. The menu item toggles, so selecting it again on an already-bookmarked message removes the bookmark.

# The Bookmarks Page

Click **Bookmarks** in the left sidebar (under Message Search) to open the bookmarks list.

Each bookmark shows:

- The sender's avatar and display name
- The room the message came from
- A preview of the message content
- The timestamp of the original message

Use the **Filter** box at the top to search bookmarks by message text, room name, or sender.

Click **Jump** on any bookmark to navigate directly to that message in its room.

Click the **trash** icon to remove a bookmark (a confirmation dialog will appear).

# Sync Across Devices

Bookmarks are stored in your Matrix account data, so they are available on any device you log in to with your account. Changes (adding or removing a bookmark) propagate to other devices automatically via your homeserver.

> **Privacy note:** Bookmark metadata including a short message preview is stored as unencrypted account data on your homeserver, regardless of whether the original room is encrypted. This is a known limitation of the current MSC — see [MSC4438](https://github.com/matrix-org/matrix-spec-proposals/pull/4438) for the ongoing spec discussion.