Architecture Decision Records
This directory contains Architecture Decision Records (ADRs) documenting significant design decisions in axeberg.
What is an ADR?
An ADR captures an important architectural decision along with its context and consequences. ADRs help future developers (including yourself) understand:
- Why decisions were made
- What alternatives were considered
- What trade-offs were accepted
ADR Index
| ADR | Title | Status |
|---|---|---|
| 001 | WebAssembly as Primary Target | Accepted |
| 002 | Custom Async Executor | Accepted |
| 003 | In-Memory Filesystem | Accepted |
| 004 | Unix-like Interface Design | Accepted |
| 005 | Single WASM Binary Architecture | Accepted |
| 006 | Cooperative Multitasking | Accepted |
ADR Template
# ADR-NNN: Title
## Status
[Proposed | Accepted | Deprecated | Superseded by ADR-XXX]
## Context
What is the issue that we're seeing that motivates this decision?
## Decision
What is the decision that we're making?
## Consequences
What are the positive and negative results of this decision?
## Alternatives Considered
What other options were evaluated?
Contributing
When making a significant architectural decision:
- Copy the template above
- Fill in the sections
- Number it sequentially
- Add to the index above
- Get feedback before marking as Accepted
Not every code change needs an ADR. Use them for: - Fundamental architectural choices - Technology selections - Patterns that will be used project-wide - Decisions that are hard to reverse