Update ADR docs to reflect profile message system#569
Conversation
How to use the Graphite Merge QueueAdd the label merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
Claude finished @yewreeka's task —— View job ADR Documentation Review — Approved ✅Excellent documentation update reflecting the migration to message-based profiles. The rewrite of ADR 005 and cross-reference updates are comprehensive and accurate. SummaryThis PR successfully updates ADR documentation to reflect the profile message system migration (PRs #529, #552, #556, #562). The changes are documentation-only with no code quality, security, or performance concerns. Key Changes:
Code Quality — ExcellentStrengths:
Minor Suggestions:
Technical Accuracy — CorrectProtocol Details:
Architecture:
No Technical Issues Found Cross-Reference Updates — ConsistentAll ADR updates correctly reference the new profile message system:
ADR 009 Enhancement: Profile avatars are transmitted via ProfileUpdate and ProfileSnapshot messages (see ADR 005)
as `EncryptedProfileImageRef` references.Documentation Quality — HighClarity:
Completeness:
Consistency:
Security Considerations — AppropriateThe documentation correctly describes:
No security documentation concerns. Test Coverage — N/AThis is documentation-only. No code tests needed. RecommendationsOptional Enhancements:
None of these are blockers — the documentation is already comprehensive and accurate. Final AssessmentApproved ✅ This PR successfully documents the profile message system migration with:
The documentation will serve as an excellent reference for understanding the profile system architecture. |
ApprovabilityVerdict: Approved Documentation-only changes updating ADR files to reflect the profile message system architecture. No runtime code is modified - these are purely markdown documentation updates describing how the system now works. You can customize Macroscope's approvability policy. Learn more. |
ADR 005 rewritten to document the current architecture: profiles stored as ProfileUpdate/ProfileSnapshot XMTP messages instead of appData. Covers message-primary reads with appData gap-fill, snapshot triggers, typed metadata, JoinRequest content type, MemberKind enum, encrypted avatar references, and migration phases. Cross-references updated in ADRs 001-004, 007, 009 to reflect that profiles no longer share the 8KB appData space.
ccf7352 to
754f629
Compare
Dismissing prior approval to re-evaluate 754f629

Updates ADR documentation to reflect the profile message system migration (PRs #529, #552, #556, #562).
Changes
ADR 005 — Full rewrite from "Profile Storage in Conversation Metadata" to "Member Profile System":
Cross-reference updates (ADRs 001, 002, 003, 004, 007, 009):
Note
Update ADR docs to reflect the profile message system replacing appData-based profile storage
ProfileUpdate(self-authored) andProfileSnapshot(bulk, sent on group creation or member join).MemberKind, typed metadata viamap<string, MetadataValue>, andEncryptedProfileImageReffor avatars.appDataspace.appDataprofile writes.Macroscope summarized 754f629.