Documentation for the Promptimize VSCode/Cursor extension.
| Document | Purpose |
|---|---|
| Quick Start | Install, first recording, troubleshooting |
| Recording Modes | Transcribe vs Promptimize workflows |
| Keyboard Shortcuts | Keybindings and Command Palette reference |
| Troubleshooting | Decision trees for common issues |
| Configuration Guide | Whisper setup, optimization providers, settings |
| Configuration Webview | Interactive setup panel features |
| Provider Selection | When to use which provider |
| Advanced Settings | Transcription hints, planned settings, test output |
| Document | Purpose |
|---|---|
| Architecture Overview | Layers, components, data flow |
| Architecture Decision Records | Why key technical choices were made |
| Complete Flow | End-to-end runtime behavior |
| Document | Purpose |
|---|---|
| Testing Strategy | Test priorities and manual smoke checklist |
| Release Process | Build, package, and publish |
| Coding Conventions | Naming, structure, review checklist |
| Document | Purpose |
|---|---|
| UX States | Status bar states, notifications, error copy |
| Security & Privacy | Data handling, API keys, threat model |
| Technical Research | API constraints, Cursor compatibility findings |
Implementation details live in src/ with TypeScript types and JSDoc.
- Architecture Overview
- ADRs for key decisions
- Complete Flow
- Testing Strategy
- Browse
src/for implementation
- Release Process
- Project Progress
- Update ADRs when making architectural changes
| Change type | Update |
|---|---|
| Architecture | architecture/overview.md + new ADR |
| User-facing features | user-guide/, configuration/, quickstart.md, root README.md |
| Bug fixes (user-facing) | user-guide/troubleshooting.md, root README.md |
| Release process | deployment/release-process.md |
Documentation changes belong in the same PR as code changes when behavior changes.