vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(tools/matrix): update wake body format to reflect rich unread summary

Browse source 
The matrix wake body description said '[matrix] <sender> in <room>:
<first-100c>...' (old single-line teaser). After feat(#1137) it's now
a richer format:
- Single room, 1 message: terse one-liner with sender + body
- Single room, N messages: count + room name
- Multi-room: bulleted list with per-room summaries

Also note that the same breakdown appears in get_loose_ends via the
UnreadMatrix entry.
This commit is contained in:
iris 2026-06-05 16:09:25 +02:00 • committed by mara
commit 76040407b6
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/tools/matrix.md
View file

@ -46,8 +46,19 @@ silently exit when `<state>/matrix-token` is absent (account not yet
provisioned).
Incoming room events wake the agent via `AgentRequest::Wake` with
`from: "matrix"` and a teaser body
(`[matrix] <sender> in <room>: <first-100c>…`).
`from: "matrix"`. The wake body format depends on the unread state:
- **Single room, one message**: `[matrix] <sender> in <room>: <body> —
use read_room to view, mark_read to clear`
- **Single room, multiple messages**: `[matrix] N unread in <room> —
use read_room to view, mark_read to clear`
- **Multiple rooms**: `[matrix] unread messages:` followed by a
bulleted list (`- <room>: <sender>: <body>` or `- <room>: N unread`
per room)
The same per-room breakdown is included in the `UnreadMatrix` entry
returned by `get_loose_ends` so unread rooms surface in the
loose-ends list between turns.
See [`docs/matrix.md`](../matrix.md) for the homeserver setup,
provisioning flow, and federation config.