fetch_ml/docs/src/adr
Jeremie Fraeys d673bce216
docs: fix mermaid graphs and update outdated content
- Fix mermaid graph syntax errors (escape parentheses in node labels)
- Move mermaid-init.js to Hugo static directory for correct MIME type
- Update Future Extensions section in cli-tui-ux-contract-v1.md to match current roadmap
- Add ADR-004 through ADR-007 documenting C++ native optimization strategy
2026-02-16 20:37:38 -05:00
..
ADR-001-use-go-for-api-server.md Fix multi-user authentication and clean up debug code 2025-12-06 12:35:32 -05:00
ADR-002-use-sqlite-for-local-development.md Fix multi-user authentication and clean up debug code 2025-12-06 12:35:32 -05:00
ADR-003-use-redis-for-job-queue.md Fix multi-user authentication and clean up debug code 2025-12-06 12:35:32 -05:00
ADR-004-use-cpp-for-selective-native-optimization.md docs: fix mermaid graphs and update outdated content 2026-02-16 20:37:38 -05:00
ADR-005-batch-first-apis-for-cgo-amortization.md docs: fix mermaid graphs and update outdated content 2026-02-16 20:37:38 -05:00
ADR-006-runtime-simd-detection.md docs: fix mermaid graphs and update outdated content 2026-02-16 20:37:38 -05:00
ADR-007-simplified-streaming-io.md docs: fix mermaid graphs and update outdated content 2026-02-16 20:37:38 -05:00
README.md docs: fix mermaid graphs and update outdated content 2026-02-16 20:37:38 -05:00

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records (ADRs) for the Fetch ML project.

What are ADRs?

Architecture Decision Records are short text files that document a single architectural decision. They capture the context, options considered, decision made, and consequences of that decision.

ADR Template

Each ADR follows this structure:

# ADR-XXX: [Title]

## Status
[Proposed | Accepted | Deprecated | Superseded]

## Context
[What is the issue that we're facing that needs a decision?]

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

## Options Considered
[What other approaches did we consider and why did we reject them?]

ADR Index

ADR Title Status
ADR-001 Use Go for API Server Accepted
ADR-002 Use SQLite for Local Development Accepted
ADR-003 Use Redis for Job Queue Accepted
ADR-004 Use C++ for Selective Native Optimization Proposed
ADR-005 Use Batch-First APIs for CGo Amortization Proposed
ADR-006 Use Runtime SIMD Detection Proposed
ADR-007 Simplified Streaming I/O Without io_uring Proposed

How to Add a New ADR

  1. Create a new file named ADR-XXX-title.md where XXX is the next sequential number
  2. Use the template above
  3. Update this README with the new ADR in the index
  4. Submit a pull request for review

ADR Lifecycle

  • Proposed: Initial draft, under discussion
  • Accepted: Decision made and implemented
  • Deprecated: Decision no longer recommended but still in use
  • Superseded: Replaced by a newer ADR