docs(guides): DOC-04 - add message editing guide#53
Merged
Killea merged 1 commit intoKillea:mainfrom Mar 8, 2026
Merged
Conversation
- New guide: docs/guides/message-editing.md (10 sections, ~250 lines)
- Covers data model (Message fields + MessageEdit table), permissions,
content filter, REST API (PUT /api/messages/{id} + GET history),
MCP tools (msg_edit + msg_edit_history), version history, SSE events,
human-only content projection, and common patterns
- Register guide in mkdocs.yml nav under Guides
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/guides/message-editing.mddocumenting the UP-21 message edit/versioning featuremkdocs.ymlnav under GuidesMotivation
UP-21 (message editing) has been implemented and tested but had no user-facing documentation. This guide gives users and agent developers a single reference for all editing-related endpoints and behaviours.
Test plan
mkdocs serverenders the guide without errorsGuides > Message Editingresolves to the correct pagePUT /api/messages/{id}andGET /api/messages/{id}/historyinsrc/main.py