55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
|
# Architecture Decision Records (ADRs)
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
**Purpose**: Document important architectural and technical decisions
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This directory contains Architecture Decision Records (ADRs) documenting important decisions made about the workspace structure, tooling, and architecture.
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## ADR Format
|
||
|
|
|
||
|
|
### Standard ADR Structure
|
||
|
|
```markdown
|
||
|
|
# [ADR-XXXX]: [Title]
|
||
|
|
|
||
|
|
**Status**: [Proposed/Accepted/Deprecated/Superseded]
|
||
|
|
**Date**: [YYYY-MM-DD]
|
||
|
|
**Deciders**: [List of decision makers]
|
||
|
|
**Context**: [Background and context]
|
||
|
|
**Decision**: [Decision made]
|
||
|
|
**Consequences**: [Implications and consequences]
|
||
|
|
```
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## ADR Index
|
||
|
|
|
||
|
|
### Workspace Structure
|
||
|
|
- [ADR-0001: Use Monorepo Structure](./0001-use-monorepo-structure.md) - Decision to use monorepos for related projects
|
||
|
|
|
||
|
|
### Tooling
|
||
|
|
- [ADR-0002: Standardize on pnpm and Turborepo](./0002-standardize-pnpm-turborepo.md) - Standard package manager and build tool
|
||
|
|
- [ADR-0003: Use Git Submodules for External Projects](./0003-use-git-submodules.md) - Decision to use submodules for external repos
|
||
|
|
|
||
|
|
### Architecture
|
||
|
|
- [ADR-0004: Hybrid Cloud Architecture](./0004-hybrid-cloud-architecture.md) - Decision to use hybrid cloud (Proxmox + Azure)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Creating New ADRs
|
||
|
|
|
||
|
|
1. Create new ADR file: `ADR-XXXX-[title].md`
|
||
|
|
2. Follow ADR format
|
||
|
|
3. Update this index
|
||
|
|
4. Submit for review
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
|