Skip to content

Latest commit

 

History

History
81 lines (65 loc) · 4.65 KB

README.md

File metadata and controls

81 lines (65 loc) · 4.65 KB

Architecture Decision Records

This directory is the canonical record of architectural decisions for Argus.

Lifecycle

stateDiagram-v2
    [*] --> Proposed
    Proposed --> Accepted
    Proposed --> Rejected
    Proposed --> Deferred
    Accepted --> Deprecated
    Accepted --> Superseded
    Deferred --> Proposed
    Deprecated --> [*]
    Rejected --> [*]
    Superseded --> [*]
Loading

Status Definitions

  • Proposed — under discussion; not yet binding.
  • Accepted — binding for future work until superseded or deprecated.
  • Rejected — considered and intentionally not chosen.
  • Deferred — valid question, but not decided now.
  • Deprecated — previously accepted, no longer recommended for new work.
  • Superseded — replaced by a newer ADR.

Transition Rules

  • Proposed ADRs can become Accepted, Rejected, or Deferred.
  • Accepted ADRs are immutable as historical records; create a new ADR to reverse or materially change one.
  • Superseding ADRs must reference the ADR they replace.
  • Deprecated ADRs should explain what changed and what current work should do instead.

File Naming

Use:

NNNN-kebab-case-title.md

Examples:

  • 0001-use-architecture-decision-records.md
  • 0008-isolate-heavy-and-crashy-backends-in-subprocesses.md

Principles

  • One decision per ADR.
  • Record the forces and consequences, not just the outcome.
  • Be honest about negative consequences.
  • Prefer references to source documents, code, or research over vague memory.
  • Do not rewrite accepted ADR history; supersede it.

Index

ADR Title Status Category
0001 Use Architecture Decision Records Accepted Process / Workflow
0002 Use MuJoCo CPU Simulation as the Platform Boundary Accepted Technology Choice
0003 Use Ground-Truth World Poses to Remove Map Alignment as a Variable Accepted Architecture Pattern
0004 Use In-Process Transport for Local Coordination Accepted Integration Strategy
0005 Use Browser-Based Command and Control with WebSocket Streaming Accepted Architecture Pattern
0006 Use Protocol and Registry Pattern for Pluggable Backends Accepted Architecture Pattern
0007 Split 2D Detection from 3D Lifting Accepted Architecture Pattern
0008 Isolate Heavy and Crashy Backends in Subprocesses Accepted Integration Strategy
0009 Use Newest-Wins Per-Robot Workers for Perception Accepted Architecture Pattern
0010 Use Canonical Server-Owned OBB Wire Format Accepted Data Model
0011 Use CPU-Viable Model Tiers and Pinned Offline Checkpoints Accepted Technology Choice
0012 Forbid Fake mAP and Use MuJoCo Ground-Truth Metrics Accepted Testing Strategy
0013 Use Server-Owned Geometry and a Single Projection Path Accepted Data Model
0014 Use React Flow Typed DAG for Pipeline Editing Accepted Architecture Pattern
0015 Introduce Robot Platform Abstraction Proposed Architecture Pattern
0016 Use MuJoCo First for AGIBOT X2 Simulation Proposed Technology Choice
0017 Treat X2 Locomotion as External Walking Policy Boundary Proposed API Design
0018 Use Reproducible Gymnasium-Style Locomotion Benchmark Harness Proposed Architecture Pattern
0019 Benchmark Locomotion Before Adding New Controller Families Proposed Process / Workflow
0020 Evaluate Exploration Against a Fixed Reference Area Proposed Testing Strategy