Architecture
This section documents the key architectural decisions that shaped the project. Each decision explains what was decided, why, and under what conditions it could be revisited.
Context
Architectural choices in this project span: testing infrastructure, data pipeline design, alert systems, external API integration, portfolio decision logic, CI/CD strategy, and documentation governance. Decisions were made incrementally over Nov 2025-July 2026 and are sourced from docs/activity_report/.
Details
Contents of this section
| File | Purpose |
|---|---|
| key-decisions.md | Complete log of major architectural decisions with status, rationale, impact, and reversal conditions |
How to read a decision entry
Each entry in key-decisions.md follows this structure:
- Status: current (active) or superseded (replaced by a newer decision)
- Date: when the decision was formalized
- Context: the problem or situation that triggered the decision
- Resolution: what was decided
- Impact: what changed as a result
- Reversal conditions: what circumstances would require revisiting the decision
- Source: link to the activity report where this decision was documented
Incidents & Lessons (V1)
During V1, any incidents or operational lessons are documented at the bottom of key-decisions.md under the "Incidents & Lessons" sub-section. These will be migrated to ../06_lessons-learned/ when V2 is delivered.
Links
- key-decisions.md — full decision log
- ../05_common-patterns/ — implementation patterns derived from these decisions
- ../README.md — wiki navigation guide