This directory contains Architecture Decision Records for Promptimize.
An Architecture Decision Record (ADR) is a document that captures an important architectural decision made along with its context and consequences.
- Document decisions: Capture the "why" behind architectural choices
- Provide context: Help future contributors understand past reasoning
- Enable review: Allow stakeholders to review and discuss decisions
- Track evolution: Show how architecture evolved over time
Each ADR follows this structure:
- Title: Short noun phrase
- Status: Proposed, Accepted, Deprecated, Superseded
- Context: What is the issue we're facing?
- Decision: What is the change we're proposing/doing?
- Consequences: What becomes easier or harder?
- ADR-0001 - Use TypeScript for Extension Development
- ADR-0002 - Adopt Clean/Hexagonal Architecture
- ADR-0003 - Use OpenAI Whisper for Transcription
- ADR-0004 - Implement Dependency Injection Pattern
- ADR-0005 - Use Webview with MediaRecorder for Audio Capture (Superseded)
- ADR-0006 - Chain of Responsibility for Text Insertion
- ADR-0007 - Prioritize Classic Mode Compatibility
- ADR-0008 - Use VSCode SecretStorage for API Keys
- ADR-0009 - No Persistent Audio Storage
- ADR-0010 - Use React for Webview UI (Superseded)
- ADR-0011 - Use GPT-4 for Prompt Transformation
- ADR-0012 - Use Mono Audio at 16kHz Sample Rate
- ADR-0013 - Use Native Audio Capture with @kstonekuan/audio-capture
- ADR-0014 - Support Multiple Transformation Providers
- None currently
- Copy
template.mdto new file:XXXX-title-in-kebab-case.md - Number sequentially from last ADR
- Fill in all sections
- Submit for review via PR
- Update this index
Proposed → Accepted → [Deprecated | Superseded]
- Proposed: Under discussion, not yet implemented
- Accepted: Decision made and being/been implemented
- Deprecated: No longer recommended but not yet replaced
- Superseded: Replaced by a newer ADR