Skip to content

Files

Latest commit

d79c90c · Feb 17, 2025

History

History

adr

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Feb 17, 2025

Architecture Decision Records (ADR)

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

What is an ADR?

An Architecture Decision Record is a document that captures an important architectural decision made along with its context and consequences.

ADR Format

Each ADR follows this format:

# ADR {number}: {title}

## Status

[Proposed | Accepted | Deprecated | Superseded]

## 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?

List of ADRs

Project Structure

Building Blocks

Workflows

Agents

Infrastructure

Creating New ADRs

  1. Copy the template from template.md
  2. Create a new file with the next number in sequence
  3. Fill in the sections
  4. Add a link to this index
  5. Submit for review

Superseded ADRs

When an ADR is superseded, update its status and add a link to the new ADR that supersedes it.