Skip to content

README.md

Latest commit

 

History

History
93 lines (64 loc) · 3.57 KB

README.md

File metadata and controls

93 lines (64 loc) · 3.57 KB

Architecture Decision Records (ADR)

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

What is an ADR?

An Architecture Decision Record captures an important architectural decision made along with its context and consequences. ADRs help:

  • Understand the rationale behind design choices
  • Onboard new team members
  • Prevent repeating past discussions
  • Document architectural evolution over time

ADR Format

Each ADR follows this structure:

  • Status: Proposed | Accepted | Deprecated | Superseded
  • Date: When the decision was made
  • Context: The issue motivating this decision
  • Decision: The change being proposed or made
  • Consequences: Positive, negative, and neutral impacts

Current ADRs

ID Title Status Date
ADR-001 Choice of Sparse Ternary VSA Accepted 2025-12-15
ADR-002 Multi-Agent Workflow System Accepted 2025-12-15
ADR-003 Self-Hosted Runner Architecture Accepted 2025-12-22
ADR-004 Holographic OS Container Design Accepted 2025-12-15
ADR-005 Hologram-Based Package Isolation and Factoralization Proposed 2025-12-23
ADR-006 Dimensionality and Sparsity Scaling in Holographic Space Proposed 2025-12-23
ADR-007 Codebook Security and Reversible Encoding Proposed 2025-12-23
ADR-008 Bundling Semantics and Cost-Aware Hybrid Proposed 2026-01-01
ADR-009 Deterministic Hierarchical Artifact Generation Accepted 2026-01-01
ADR-010 Router+Shard Architecture for Bounded Node Indexing Accepted 2026-01-01
ADR-011 Multi-Input Ingest and Namespace Management Accepted 2026-01-01
ADR-012 Reusable Codebook Index for Query Performance Accepted 2026-01-01
ADR-013 Hierarchical Manifest Format and Versioning Accepted 2026-01-01
ADR-014 Incremental Updates Accepted 2026-01-01
ADR-017 Phase 2A Component Extraction Strategy Accepted 2026-01-04

Creating a New ADR

When making a significant architectural decision:

  1. Copy the template below
  2. Number it sequentially (ADR-00X)
  3. Fill in all sections
  4. Submit for review via pull request
  5. Update this README's table

Template

# ADR-XXX: [Title]

## Status

[Proposed | Accepted | Deprecated | Superseded by ADR-YYY]

## Date

YYYY-MM-DD

## Context

[Describe the issue or situation requiring a decision]

## Decision

[Describe the decision and its rationale]

## Consequences

### Positive
- [List positive outcomes]

### Negative
- [List negative outcomes and trade-offs]

### Neutral
- [List neutral impacts or considerations]

## References

- [Links to related documentation, issues, or PRs]

References