kiro-spec-engine 1.2.3 → 1.4.0

package/CHANGELOG.md

@@ -7,6 +7,141 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.4.0] - 2026-01-23
+
+### Added - User Onboarding and Documentation Overhaul 📚
+
+**Complete Documentation Restructure**:
+- **New Positioning**: Repositioned kse as "A context provider for AI coding tools"
+- **Three-Tier Structure**: README → Core Guides → Tool-Specific Guides
+- **"What kse is NOT" Section**: Clear clarification of kse's role
+
+**New Documentation** (20+ new files):
+- **Quick Start Guide** (`docs/quick-start.md`): Complete 5-minute tutorial with user-login example
+- **6 Tool-Specific Guides**:
+  - Cursor Integration Guide
+  - Claude Code Integration Guide
+  - Windsurf Integration Guide
+  - Kiro Integration Guide
+  - VS Code + Copilot Integration Guide
+  - Generic AI Tools Guide
+- **Core Guides**:
+  - Spec Workflow Guide (deep dive into Spec creation)
+  - Integration Modes Guide (Native, Manual Export, Watch Mode)
+  - Troubleshooting Guide (organized by category)
+  - FAQ (frequently asked questions)
+- **3 Complete Example Specs**:
+  - API Feature Example (RESTful API with authentication)
+  - UI Feature Example (React dashboard)
+  - CLI Feature Example (export command)
+- **Documentation Index** (`docs/README.md`): Comprehensive navigation hub
+
+**Visual Enhancements**:
+- **3 Mermaid Diagrams**:
+  - Spec creation workflow diagram
+  - Integration modes diagram
+  - Context flow sequence diagram
+
+**Bilingual Support**:
+- **Complete Chinese Translations**:
+  - Chinese README (`README.zh.md`)
+  - Chinese Quick Start Guide (`docs/zh/quick-start.md`)
+  - All 6 tool guides translated (`docs/zh/tools/`)
+  - Chinese documentation index (`docs/zh/README.md`)
+
+**Metadata and Navigation**:
+- Added version, date, audience, and time estimates to all major docs
+- Cross-document linking with "Related Documentation" sections
+- "Next Steps" sections for progressive learning
+- "Getting Help" sections with multiple support channels
+
+### Changed
+
+- **README.md**: Complete restructure with embedded quick start and clear positioning
+- **README.zh.md**: Updated to match new English structure
+- All documentation now emphasizes kse's role as a context provider for AI tools
+
+### Improved
+
+- **User Experience**: Reduced time-to-first-feature from unclear to 5 minutes
+- **Tool Integration**: Clear guidance for 6 major AI tools
+- **Learning Path**: Progressive disclosure from beginner to advanced
+- **Accessibility**: Bilingual support for English and Chinese developers
+
+## [1.3.0] - 2026-01-23
+
+### Added - Watch Mode Automation System 🤖
+
+**Core Components** (2150+ lines of code, 172 tests):
+- **FileWatcher**: Cross-platform file monitoring with chokidar
+  - Glob pattern matching with minimatch
+  - Configurable ignored patterns
+  - Event emission for file changes
+  - Error recovery and health monitoring
+- **EventDebouncer**: Smart event management
+  - Debounce and throttle logic
+  - Event queue with duplicate prevention
+  - Configurable delays per pattern
+- **ActionExecutor**: Command execution engine
+  - Shell command execution with context interpolation
+  - Retry logic with exponential/linear backoff
+  - Timeout handling and process management
+  - Command validation and security
+- **ExecutionLogger**: Complete audit trail
+  - Log rotation by size
+  - Metrics tracking (executions, time saved, success rates)
+  - Export to JSON/CSV
+  - Configurable log levels
+- **WatchManager**: Central coordinator
+  - Lifecycle management (start/stop/restart)
+  - Configuration loading and validation
+  - Status reporting and metrics
+
+**CLI Commands** (7 commands):
+- `kse watch init` - Initialize watch configuration
+- `kse watch start/stop` - Control watch mode
+- `kse watch status` - Show current status
+- `kse watch logs` - View execution logs (with tail/follow)
+- `kse watch metrics` - Display automation metrics
+- `kse watch presets` - List available presets
+- `kse watch install <preset>` - Install automation preset
+
+**Automation Presets** (4 presets):
+- `auto-sync` - Automatically sync workspace when tasks.md changes
+- `prompt-regen` - Regenerate prompts when requirements/design change
+- `context-export` - Export context when tasks complete
+- `test-runner` - Run tests when source files change
+
+**Tool Detection & Auto-Configuration**:
+- Automatic IDE detection (Kiro IDE, VS Code, Cursor)
+- Tool-specific automation recommendations
+- Auto-configuration during project adoption
+- Confidence-based suggestions
+
+**Manual Workflows** (6 workflows):
+- Complete workflow guide (300+ lines)
+- `kse workflows` command for workflow management
+- Step-by-step instructions with time estimates
+- Interactive checklists for common tasks
+- Workflows: task-sync, context-export, prompt-generation, daily, task-completion, spec-creation
+
+### Enhanced
+- **README.md**: Added comprehensive automation section
+- **Project Adoption**: Integrated tool detection with automation setup
+- **Documentation**: Complete manual workflows guide
+
+### Testing
+- 289 tests passing (100% pass rate)
+- 279 unit tests
+- 10 integration tests
+- Full coverage of all watch mode components
+
+### Performance
+- Efficient file watching with debouncing
+- Configurable retry logic
+- Log rotation to prevent disk space issues
+- Metrics tracking for optimization
+
 ## [1.2.3] - 2026-01-23
 
 ### Added