Skip to content

docs(design): add Magic Pocket and Satchel architecture diagrams - #57

Open
frectrium wants to merge 1 commit into
mainfrom
docs/11-architecture-diagram
Open

frectrium wants to merge 1 commit into
mainfrom
docs/11-architecture-diagram

Conversation

@frectrium

@frectrium frectrium commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

What

Adds docs/design/architecture.md: a Magic Pocket diagram and a matching Satchel diagram, each with numbered put and get paths, a one-line role per component with source IDs, and a table of what Satchel keeps and simplifies.

Closes #11

Why

Objective 2 in the brief, and the architecture section of the Week 2 report (#18). The solution section (#50) is waiting on this diagram.

How to check it

Merge order

Merge after the Design Decision Log (#55) and the exercise plan (#56), since the Satchel half follows them.

Checklist

  • cargo fmt, cargo clippy and cargo test pass locally (code PRs)
  • Tests added or updated for the change (code PRs)
  • New sources are added to docs/sources/README.md (research PRs)
  • Design decisions are recorded in the Design Decision Log
  • Docs and README are updated if behaviour or setup changed

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.

[Design] Draw the Magic Pocket architecture diagram

1 participant