Skip to content

docs(design): add the Design Decision Log with first entries - #55

Open
frectrium wants to merge 1 commit into
mainfrom
docs/17-decision-log
Open

frectrium wants to merge 1 commit into
mainfrom
docs/17-decision-log

Conversation

@frectrium

@frectrium frectrium commented Oct 28, 2026 •

Copy link
Copy Markdown
Owner

What

Adds docs/design/decision-log.md: the template, how to add an entry, and the first 15 entries (DDL-001 to DDL-015) seeded from the exercise plan (#14). Also links the "Design decisions are recorded" box in the PR template to the log.

Closes #17

Why

The brief asks for a Design Decision Log by the end of Week 2. Every Satchel choice needs its Magic Pocket counterpart, Dropbox's reasoning and a source, and #27 turns this file into a report chapter in Week 4.

How to check it

Merge order

This PR, the exercise plan (#56) and the architecture doc (#57) link to each other. Merge this one first, then #56, then #57. Links between them are broken until all three are in.

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.

[Docs] Create the Design Decision Log doc

1 participant