Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 2.25 KB

File metadata and controls

79 lines (49 loc) · 2.25 KB

Architecture Decision Records

This directory contains Architecture Decision Records (ADRs) documenting significant decisions made in this dotfiles configuration.

What is an ADR?

An ADR is a document that captures an important architectural decision made along with its context and consequences. They help future-you (and others) understand:

  • Why a decision was made
  • What alternatives were considered
  • When the decision was made
  • What the consequences are

ADRs

ID Title Status Date
001 Multi-Machine Nix Configuration Accepted 2025-01
002 XDG Compliance and Session Variables Accepted 2025-01
003 Nix LSP Maintainability Trade-off Accepted 2025-01
004 Developer Directory Structure Accepted 2025-01
005 Home-Manager Module Structure Superseded 2026-01
006 1Password SSH Agent Integration Accepted 2026-01
007 Flake-Parts and Dendritic Migration Accepted 2026-02

Creating a New ADR

  1. Copy the template below
  2. Create a new file: NNN-title-with-dashes.md
  3. Fill in the sections
  4. Add an entry to the table above

Template

# ADR-NNN: Title

## Status

Proposed | Accepted | Deprecated | Superseded by [ADR-XXX](./XXX-title.md)

## Date

YYYY-MM-DD

## Context

What is the issue that we're seeing that is motivating this decision or change?

## Decision

What is the change that we're proposing and/or doing?

## Consequences

What becomes easier or more difficult to do because of this change?

### Positive

- ...

### Negative

- ...

### Neutral

- ...

## Alternatives Considered

What other options were considered and why were they not chosen?

## References

- Links to relevant resources, discussions, or documentation