docs: event-log design doc, design/ in CLAUDE.md, and 0.8.0 changelog - #213
Merged
Conversation
Living design doc covering the append-only memory_event audit log, transaction-local attribution, per-event-tree-gated history reads (scopes, date windows, event_id keyset pagination, deleted-path resolution), and version revert/undelete (full-snapshot restore, deliberate override, and version + content_version continuation).
Add a Design docs section pointing contributors to design/ (living, contributor-facing subsystem docs) and distinguishing it from docs/ (user-facing, published). Fix the stale audience note that referenced now-removed root *_DESIGN.md files.
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation follow-up to the audit-log / history / revert feature, adding a contributor-facing living design document, clarifying where design docs live, and drafting the 0.8.0 release notes.
Changes:
- Added a new living design doc describing the
memory_eventaudit log, history reads, and revert/undelete semantics. - Updated contributor guidance in
CLAUDE.mdto distinguish user-facingdocs/from internal living design docs indesign/. - Added 0.8.0 release notes to the changelog and indexed the new design doc in
design/README.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| design/README.md | Adds the new event-log/history design doc to the design-doc index. |
| design/event-log-and-history.md | New living design document covering the audit log, history gating/pagination, retention, and revert/undelete behavior. |
| CLAUDE.md | Adds a “Design docs” section and updates the documentation audience guidance to reference design/. |
| CHANGELOG.md | Adds the 0.8.0 release notes describing history + revert/undelete and related schema notes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Documentation follow-up to the memory audit-log feature (merged in #212), plus the 0.8.0 release notes.
Changes
design/event-log-and-history.md— a new living design document covering the append-onlymemory_eventaudit log: append-only vs prior-state archival, transaction-local attribution, storage/indexes/30-day retention, per-event-tree-gated history reads (scopes, date windows,event_idkeyset pagination, deleted-path resolution), and revert/undelete (full-snapshot restore, deliberate override, andversion+content_versioncontinuation). Indexed indesign/README.md.CLAUDE.md— adds a "Design docs" section pointing contributors todesign/(living, contributor-facing subsystem docs) and distinguishing it fromdocs/(user-facing, published). Also fixes the stale audience note that referenced now-removed root*_DESIGN.mdfiles. (AGENTS.mdis a symlink toCLAUDE.md, so both update.)CHANGELOG.md— 0.8.0 release notes for the audit-history feature (memory.history+memory.revertacross RPC/CLI/MCP; space schema → 0.0.9, core → 0.0.7;MIN_SERVER_VERSION→ 0.8.0).Release
Docs/notes only — no version bumps or tags here. After merge, the release is cut with the interactive scripts: