Private
Public Access
Bump to v1.1.0 and bring all documentation current
Version bump in both pyproject.toml and package.json. Documentation update covers everything shipped since v1.0.0 (direct messages, message deletion, custom emoji, video attachments, DM/room email notifications, active sessions, and more), and corrects claims that had gone stale -- backend/README.md and DEPLOYMENT.md both still said "no server-side session revocation" and backend/README.md said "no custom/uploaded emoji," both now false. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
+59
-9
@@ -7,15 +7,17 @@ attachments, notifications, and personalizing your account.
|
||||
|
||||
- [Getting started](#getting-started)
|
||||
- [Rooms](#rooms)
|
||||
- [Direct messages](#direct-messages)
|
||||
- [Sending messages](#sending-messages)
|
||||
- [Formatting](#formatting)
|
||||
- [Mentions and room links](#mentions-and-room-links)
|
||||
- [Attachments](#attachments)
|
||||
- [Reactions](#reactions)
|
||||
- [Editing a message](#editing-a-message)
|
||||
- [Reactions and custom emoji](#reactions-and-custom-emoji)
|
||||
- [Editing and deleting a message](#editing-and-deleting-a-message)
|
||||
- [Presence and notifications](#presence-and-notifications)
|
||||
- [Your profile](#your-profile)
|
||||
- [Room details](#room-details)
|
||||
- [Active sessions](#active-sessions)
|
||||
- [Staying up to date](#staying-up-to-date)
|
||||
|
||||
## Getting started
|
||||
@@ -45,6 +47,21 @@ search box at the top to filter by name.
|
||||
- **Unread indicators**: a room with new activity shows a dot next to its
|
||||
name — a plain dot for unread messages, a highlighted dot if you were
|
||||
specifically @mentioned.
|
||||
- **Collapsible sections**: the **Direct Messages** and **Rooms** headers in
|
||||
the sidebar can be collapsed to hide their contents — click the header to
|
||||
toggle. Your choice is remembered.
|
||||
|
||||
## Direct messages
|
||||
|
||||
Click **People** to see everyone on the site and start a 1:1 conversation
|
||||
with someone — it opens (or reopens, if you've messaged them before)
|
||||
under **Direct Messages** in the sidebar. There's only ever one
|
||||
conversation per pair of people, however many times you start it.
|
||||
|
||||
You can hide a conversation you're done with (its own menu, or from its
|
||||
**Room details** panel) without deleting anything — it drops out of your
|
||||
sidebar but reappears automatically the moment the other person sends a
|
||||
new message, or if you message them again yourself.
|
||||
|
||||
## Sending messages
|
||||
|
||||
@@ -61,7 +78,9 @@ Messages support Markdown:
|
||||
- `-` or `1.` for bulleted/numbered lists
|
||||
- `[link text](https://example.com)` — or just paste a bare URL and it
|
||||
becomes clickable automatically
|
||||
- `#`, `##`, `###` for headings
|
||||
- `#`, `##`, `###` for headings — add `{#custom-id}` at the end of a
|
||||
heading line to control its link anchor instead of the auto-generated one
|
||||
- `~sub~` and `^sup^` for subscript and superscript
|
||||
|
||||
Pasting a link on its own often also generates a preview card underneath
|
||||
your message, pulled from that page's title/description/image, when the
|
||||
@@ -69,7 +88,9 @@ page provides one.
|
||||
|
||||
Emoji: click the 🙂 button in the composer to open the emoji picker, or
|
||||
type a shortcode like `:tada:` and it's converted automatically once you
|
||||
send. The picker remembers your recently-used emoji and has a search box.
|
||||
send. The picker remembers your recently-used emoji and has a search box —
|
||||
see [Reactions and custom emoji](#reactions-and-custom-emoji) for uploading
|
||||
your own.
|
||||
|
||||
## Mentions and room links
|
||||
|
||||
@@ -87,26 +108,39 @@ can see the message (and is a member of that room) straight to it.
|
||||
|
||||
Click the paperclip icon to attach a file, or just drag a file onto the
|
||||
message box and drop it. Images show as an inline thumbnail — click one
|
||||
to view it full-size. Other files show as a small card with the
|
||||
filename and size; `.txt`, `.md`, and `.pdf` files open in a preview
|
||||
without leaving the room, everything else downloads when clicked.
|
||||
to view it full-size. Common video formats (MP4, WebM, Ogg) play inline
|
||||
too, with a button to expand to a larger view; other files show as a
|
||||
small card with the filename and size — `.txt`, `.md`, and `.pdf` files
|
||||
open in a preview without leaving the room, everything else downloads
|
||||
when clicked.
|
||||
|
||||
There's a server-configured maximum file size — if a file is too large,
|
||||
you'll see an error before it uploads.
|
||||
|
||||
## Reactions
|
||||
## Reactions and custom emoji
|
||||
|
||||
Hover over a message and click the 🙂 icon in its action row to react
|
||||
with an emoji. Reactions from everyone appear as small pills under the
|
||||
message with a count; click an existing pill to add or remove your own
|
||||
reaction to it. Hovering a pill shows who reacted.
|
||||
|
||||
## Editing a message
|
||||
Anyone can add a custom emoji: open the emoji picker (the 🙂 button, either
|
||||
in the composer or on a message) and click **+ Add** in the **Custom**
|
||||
section. Give it a short name and an image — it's then usable by everyone,
|
||||
both as a reaction and inline in message text via `:your-name:`, right
|
||||
alongside the built-in picker. You can remove a custom emoji you uploaded
|
||||
(or any of them, if you're a site admin) from the same picker.
|
||||
|
||||
## Editing and deleting a message
|
||||
|
||||
You can edit any message you sent: hover it and click **Edit**, make your
|
||||
changes, then press **Enter** to save or **Escape** to cancel. Clicking
|
||||
away also saves. Edited messages are marked *(edited)*.
|
||||
|
||||
To delete a message you sent, hover it and click **Delete**. It's replaced
|
||||
with a "message deleted" placeholder rather than disappearing outright, so
|
||||
the conversation doesn't visibly shift for anyone else reading it.
|
||||
|
||||
## Presence and notifications
|
||||
|
||||
Everyone's avatar shows a small status dot — green for online, grey for
|
||||
@@ -124,6 +158,12 @@ The same menu has a notifications toggle:
|
||||
get a notification whenever the app is minimized *or* simply not the
|
||||
focused window, even if it's still open somewhere on screen.
|
||||
|
||||
You'll also get an email if someone messages you in a direct conversation
|
||||
while you're genuinely offline — no setup needed. For regular rooms,
|
||||
email is opt-in per room: open a room's **Room details** panel and turn
|
||||
on **Email notifications** to get emailed on that room's first unread
|
||||
message and on every `@mention`, while you're offline.
|
||||
|
||||
## Your profile
|
||||
|
||||
Open your account menu and choose **Profile settings** to:
|
||||
@@ -135,12 +175,22 @@ Open your account menu and choose **Profile settings** to:
|
||||
live)
|
||||
- Change your password
|
||||
|
||||
## Active sessions
|
||||
|
||||
Profile settings also lists **Active sessions** — every device/browser
|
||||
currently logged into your account, with its approximate location (IP
|
||||
address) and when it was last active. If you see one you don't
|
||||
recognize, click **Revoke** to sign it out immediately. Revoking your own
|
||||
current device signs you out too.
|
||||
|
||||
## Room details
|
||||
|
||||
Click the info icon in a room's header to open its details panel, where
|
||||
you can:
|
||||
|
||||
- See who else is in the room and their role (member/admin/owner)
|
||||
- Turn on **Email notifications** for that room (see
|
||||
[Presence and notifications](#presence-and-notifications))
|
||||
- Browse and re-download every file and image ever shared in the room,
|
||||
without scrolling back through history
|
||||
- Leave the room — unless you're the owner, in which case ownership has
|
||||
|
||||
Reference in New Issue
Block a user