MinBZK/DAWO-NixOS
33
3
Fork 0
Code Issues 14 Pull requests 4 Projects Releases Wiki Activity Actions

docs(architecture): record key design decisions as ADRs #22

Merged
rutger.putter merged 2 commits from bram.buijs/DAWO-NixOS:feat/adr-architecture into main 2026-06-22 08:33:08 +00:00
Conversation 4 Commits 2 Files changed 1 +92
bram.buijs commented 2026-06-18 12:13:30 +00:00
Collaborator
Copy link

References #1.

Adds an Architecture Decision Records section to architecture.md, capturing the
decisions behind this series so the reasoning lives next to the code. Short
records, newest on top, each with context / decision / consequence:

  • ADR-0001 blocks architecture: core flake plus consumer inputs (#6, #8).
  • ADR-0002 mkForce for mandatory, mkDefault for suggested, no undefined options
    (#8).
  • ADR-0003 repo split: shared blocks plus per-organisation consumers (#8).
  • ADR-0004 pin nixpkgs to a stable release, with an unstable overlay (#11).
  • ADR-0005 BTRFS as the standard disk layout (#14).
  • ADR-0006 track lanzaboote from master.

Question: ADRs inline in architecture.md as here, or a separate docs/adr/
tree? And does #1 cover this, or should it hang off a small docs issue instead?

References #1. Adds an Architecture Decision Records section to `architecture.md`, capturing the decisions behind this series so the reasoning lives next to the code. Short records, newest on top, each with context / decision / consequence: - ADR-0001 blocks architecture: core flake plus consumer inputs (#6, #8). - ADR-0002 mkForce for mandatory, mkDefault for suggested, no undefined options (#8). - ADR-0003 repo split: shared blocks plus per-organisation consumers (#8). - ADR-0004 pin nixpkgs to a stable release, with an unstable overlay (#11). - ADR-0005 BTRFS as the standard disk layout (#14). - ADR-0006 track lanzaboote from master. Question: ADRs inline in `architecture.md` as here, or a separate `docs/adr/` tree? And does #1 cover this, or should it hang off a small docs issue instead?
Add an Architecture Decision Records section to architecture.md: blocks
architecture and the core/consumer split, mkForce-mandatory vs mkDefault-suggested
with build-time asserts, the per-organisation repo split, the nixpkgs pin plus
unstable overlay, BTRFS as the standard disk layout, and tracking lanzaboote from
master. Short records, newest on top.

Ref: #1

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
rutger.putter reviewed 2026-06-18 12:47:53 +00:00
architecture.md Outdated
@ -21,0 +109,4 @@
- Context: lanzaboote v1.0.0 sets `boot.bootspec.enable`, which nixpkgs 26.05
removed, so the pinned tag fails to evaluate on the current nixpkgs.
- Decision: track lanzaboote from master until a tagged release is compatible.
- Consequence: Secure Boot hosts evaluate again; revisit when a new tag lands.
rutger.putter commented 2026-06-18 12:47:53 +00:00
Collaborator
Copy link

Let's create an open issue to track this periodically.

Let's create an open issue to track this periodically.
rutger.putter marked this conversation as resolved
rutger.putter commented 2026-06-18 12:48:26 +00:00
Collaborator
Copy link

LGTM 👌please open the requested tracking issue and I'll merge.

LGTM 👌please open the requested tracking issue and I'll merge.
bram.buijs force-pushed feat/adr-architecture from 95932430ed to da482eef1f 2026-06-18 13:21:54 +00:00 Compare
bram.buijs commented 2026-06-18 13:45:18 +00:00
Author
Collaborator
Copy link

Opened the tracking issue: #28. It captures the ADR home/upkeep and the inline-vs-docs/adr/ question, split off from #1 as you asked. Good to merge whenever you are.

Opened the tracking issue: #28. It captures the ADR home/upkeep and the inline-vs-`docs/adr/` question, split off from #1 as you asked. Good to merge whenever you are.
Sign in to join this conversation.
Reviewers
No reviewers
rutger.putter
Labels
Clear labels   
Compat/Breaking
Breaking change that won't be backward compatible

  
Kind/Bug
Something is not working

  
Kind/Discussion
Any topic that needs discussion before a technical solution is accepted

  
Kind/Documentation
Documentation changes

  
Kind/Enhancement
Improve existing functionality

  
Kind/Feature
New functionality

  
Kind/Security
This is security issue

  
Kind/Testing
Issue or pull request related to testing

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Reviewed
Confirmed
 Issue has been confirmed

  
Reviewed
Duplicate
 This issue or pull request already exists

  
Reviewed
Invalid
 Invalid issue

  
Reviewed
Won't Fix
 This issue won't be fixed

  
Status
Abandoned
 Somebody has started to work on this but abandoned work

  
Status
Blocked
 Something is blocking this issue or pull request

  
Status
Help Wanted
 If you're looking to help out, start here

  
Status
Need More Info
 Feedback is required to reproduce issue or to continue work

  
Prio - Hoog
Hoge prioriteit

  
Prio - Laag
Lage prioriteit

  
Prio - Middel
Medium prioriteit

  
styling
Verbeteringen aan de styling

No labels
Compat/Breaking
Kind/Bug
Kind/Discussion
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Help Wanted
Status
Need More Info
Prio - Hoog
Prio - Laag
Prio - Middel
styling
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
bram.buijs
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
MinBZK/DAWO-NixOS!22
No description provided.