Skip to content
This repository was archived by the owner on Apr 22, 2026. It is now read-only.

v0.5.0: Prompt Chaining System

Choose a tag to compare

@ashmere ashmere released this 01 Jul 18:01
· 63 commits to main since this release
v0.5.0
b5569c5

DocGenAI v0.5.0: Prompt Chaining System

This major release introduces a comprehensive prompt chaining framework that enables multi-step AI generation workflows while maintaining 100% backward compatibility.

🚀 Major Features

Prompt Chaining Framework

  • Multi-step AI workflows: Break complex documentation tasks into focused steps
  • Three pre-built strategies:
    • Simple: Single-step generation (default, backward compatible)
    • Enhanced: 3-step analyze → document → enhance workflow
    • Architecture: 4-step architecture analysis with diagram specifications
  • Dependency resolution: Automatic step ordering and data flow management
  • Error handling: Robust error handling with configurable fail-fast behavior

CLI Integration

  • --chain/--no-chain flags for enabling/disabling chaining
  • --chain-strategy option to select specific chain types
  • Full backward compatibility - existing commands work unchanged
  • Configuration override support

Index and Summary Separation

  • index.md: Always generated navigational index of all documentation files
  • summary.md: Generated only with chaining enabled for comprehensive architectural overview
  • Fixed sequencing issue where index was generated before individual files

🔧 Technical Improvements

Architecture

  • ChainContext: Manages state and results between steps
  • PromptStep: Individual chain steps with dependencies and transformations
  • PromptChain: Orchestrates execution with dependency resolution
  • ChainBuilder: Pre-built chain configurations for common patterns

Testing

  • 33 new tests for all chaining components
  • 104 total tests with 100% pass rate
  • Comprehensive coverage of chain execution, error handling, and integration

Bug Fixes

  • Fixed cached result handling to properly regenerate files in target output directory
  • Resolved index.md sequencing issue with cached results
  • Enhanced error handling and logging throughout the system

📚 Documentation

Fresh Sample Output

  • Complete regeneration using enhanced chaining strategy
  • Showcases improved documentation quality with multi-step generation
  • Demonstrates new index.md and summary.md functionality

Comprehensive Guides

  • Updated README with detailed chaining strategy explanations
  • Enhanced developer documentation with implementation examples
  • Performance comparisons and usage recommendations

⚡ Performance

Strategy Steps Quality Speed (macOS) Use Case
Simple 1 Good ~17s Quick docs, CI/CD
Enhanced 3 Better ~50s Production docs
Architecture 4 Best ~70s Complex systems

🔄 Backward Compatibility

  • Chaining disabled by default - existing workflows unchanged
  • All existing CLI commands work exactly as before
  • Configuration remains optional and backward compatible
  • No breaking changes to existing APIs

🛠️ Configuration

Enable chaining in config.yaml:

chaining:
  enabled: true
  default_strategy: "enhanced"
  max_steps: 10
  timeout_per_step: 300
  fail_fast: true

📈 What's Next

This release provides the foundation for future enhancements:

  • Architecture diagram generation
  • Multi-perspective documentation
  • Quality enhancement workflows
  • Parallel step execution
  • Custom transformation functions

🔗 Differences from v0.4.0

  • New: Complete prompt chaining system with 3 pre-built strategies
  • New: Index/summary separation for better navigation
  • New: 33 comprehensive tests for chaining functionality
  • Enhanced: Fresh sample output showcasing improved quality
  • Fixed: Cached result handling and index sequencing issues
  • Improved: Documentation with comprehensive chaining guides

Full Changelog: v0.4.0...v0.5.0