Skip to content

docs(guides): DOC-05 - add reactions guide#54

Merged
Killea merged 2 commits intoKillea:mainfrom
bertheto:docs/guide-reactions
Mar 8, 2026
Merged

docs(guides): DOC-05 - add reactions guide#54
Killea merged 2 commits intoKillea:mainfrom
bertheto:docs/guide-reactions

Conversation

@bertheto
Copy link
Contributor

@bertheto bertheto commented Mar 8, 2026

Summary

  • Add docs/guides/reactions.md: complete guide for the reactions system (UP-13)
  • Register the guide in mkdocs.yml nav under Guides > Reactions

Guide contents (10 sections)

  1. Introduction — lightweight free-form annotations on messages
  2. Data ModelReaction fields, UNIQUE constraint (message_id, agent_id, reaction)
  3. IdempotencyINSERT OR IGNORE, silent duplicate handling, no-op msg_unreact
  4. MCP Toolsmsg_react / msg_unreact params, response examples, MCP vs REST agent_id note
  5. REST APIPOST, DELETE, GET endpoints with curl examples and error table
  6. SSE Eventsmsg.react / msg.unreact payloads, no noise on no-ops
  7. UI Rendering — pill grouping, count badge, agent tooltip, dark/light theme
  8. Naming Conventions — recommended labels, emoji support, case-sensitivity warning
  9. Bulk Loadingmsg_reactions_bulk batch query, 3 auto-use points
  10. Error ReferenceMESSAGE_NOT_FOUND, empty reaction, DB timeout

Source references

  • src/db/models.py L66-73
  • src/db/crud.py L1509-1641
  • src/main.py L928-998
  • src/mcp_server.py L677-703
  • src/tools/dispatch.py L855-891
  • src/static/index.html L1272-1348
  • src/static/css/main.css L1020-1043

Test plan

  • mkdocs serve — verify Reactions appears in Guides nav and page renders without errors
  • Check all admonitions render (note, tip, warning)
  • Verify code blocks have correct syntax highlighting

bertheto and others added 2 commits March 8, 2026 11:58
Document the reactions system (UP-13): data model, MCP tools
(msg_react/msg_unreact), REST API (3 endpoints), SSE events
(msg.react/msg.unreact), UI pills rendering, naming conventions,
bulk loading behaviour, and error reference.

Add Reactions entry to mkdocs.yml nav under Guides.
@Killea Killea merged commit bd0b955 into Killea:main Mar 8, 2026
1 check 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.

2 participants