- 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 |
||
|---|---|---|
| .. | ||
| ADR-001-use-go-for-api-server.md | ||
| ADR-002-use-sqlite-for-local-development.md | ||
| ADR-003-use-redis-for-job-queue.md | ||
| ADR-004-use-cpp-for-selective-native-optimization.md | ||
| ADR-005-batch-first-apis-for-cgo-amortization.md | ||
| ADR-006-runtime-simd-detection.md | ||
| ADR-007-simplified-streaming-io.md | ||
| README.md | ||
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
- Create a new file named
ADR-XXX-title.mdwhere XXX is the next sequential number - Use the template above
- Update this README with the new ADR in the index
- 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