sf-agent-framework/CHANGELOG.md

AI Agent Orchestration Framework for Salesforce Development - Two-phase architecture with 70% context reduction

# Changelog

All notable changes to the SF-Agent Framework will be documented in this file.

## [4.1.0] - 2025-08-11

### 🎉 Major Documentation Update

This release brings comprehensive documentation for every feature of the SF-Agent Framework, making it easier than ever to understand and use the framework effectively.

### Added

#### 📚 Complete Documentation Suite
- **Architecture Documentation**
  - Complete system architecture with 15+ Mermaid diagrams
  - Detailed architecture explanation document
  - Data flow patterns with visual representations
  - Component interaction diagrams

- **Core Documentation** (13 major sections)
  - Guiding Principles & Philosophy
  - Two-Phase Development Architecture  
  - Installation & Setup Guide
  - Quick Start Guide (5-minute setup)
  - Configuration Guide
  - CLI Commands Reference
  - Agent System (30+ agents documented)
  - Workflows Documentation
  - Web Bundles Guide
  - Advanced Features (Story Management, Document Sharding, etc.)
  - Best Practices Guide

#### 🔄 Enhanced Features
- **Interactive Workflow Planning** - User choice points and branching logic
- **Agent Handoff Protocol** - Formal artifact transfer between agents
- **Slash Commands in Web Bundles** - Enhanced control in ChatGPT/Gemini
- **NPM Publishing Support** - Ready for public NPM registry

### Improved

#### 📊 Visual Documentation
- All complex concepts now have Mermaid diagrams
- Color-coded architecture diagrams for better understanding
- Sequence diagrams for agent communication
- State diagrams for workflow execution
- Flowcharts for data processing

#### 🏗️ Architecture Enhancements
- Better separation of concerns
- Clearer component boundaries
- Improved error handling flows
- Enhanced security architecture documentation

### Technical Details

- **Documentation**: 50,000+ lines of comprehensive documentation
- **Diagrams**: 15+ Mermaid diagrams covering all aspects
- **Coverage**: Every feature documented with examples
- **Organization**: Hierarchical structure in `/docs` folder

### Migration Notes

No breaking changes. This version is fully backward compatible with 4.0.0.

---

## [4.0.0] - 2025-07-01

### Added
- Two-Phase Development Architecture
- 70% context reduction optimization
- Story-based context engineering
- Document sharding system
- 30+ specialized Salesforce agents
- Interactive workflows
- Web bundle generation for ChatGPT/Gemini
- MCP (Model Context Protocol) integration

### Changed
- Complete architecture redesign
- Improved agent communication
- Enhanced performance optimization

### Breaking Changes
- New phase-based architecture requires migration from v3
- Agent definitions updated for phase awareness
- Context limits enforced (128k planning, 32k development)