decision_agent 0.1.1 → 0.1.2

data/README.md

@@ -7,1054 +7,192 @@
 
 A production-grade, deterministic, explainable, and auditable decision engine for Ruby.
 
-## The Problem
-
-Enterprise applications need to make complex decisions based on business rules, but existing solutions fall short:
-
-- **Traditional rule engines**: Often lack conflict resolution, confidence scoring, and audit replay capabilities
-- **Framework-coupled solutions**: Tightly bound to specific frameworks (Rails, etc.), limiting portability
-- **AI-first frameworks**: Non-deterministic, expensive, opaque, and unsuitable for regulated domains
+**Built for regulated domains. Deterministic by design. AI-optional.**
 
-**DecisionAgent** solves these problems by providing:
+## Why DecisionAgent?
 
-1. **Deterministic decisions** - Same input always produces same output
-2. **Full explainability** - Every decision includes human-readable reasoning
-3. **Audit replay** - Reproduce any historical decision exactly
-4. **Conflict resolution** - Multiple evaluators with pluggable scoring strategies
-5. **Framework-agnostic** - Pure Ruby, no Rails/ActiveRecord/Sidekiq dependencies
-6. **AI-optional** - Rules first, AI enhancement optional
+- ✅ **Deterministic** - Same input always produces same output
+- ✅ **Explainable** - Every decision includes human-readable reasoning
+- ✅ **Auditable** - Reproduce any historical decision exactly
+- ✅ **Framework-agnostic** - Pure Ruby, works anywhere
+- ✅ **Production-ready** - Comprehensive testing, error handling, and versioning
 
 ## Installation
 
-Add to your Gemfile:
-
-```ruby
-gem 'decision_agent'
-```
-
-Or install directly:
-
 ```bash
 gem install decision_agent
 ```
 
-## Web UI - Visual Rule Builder 🎯
-
-For non-technical users, DecisionAgent includes a web-based visual rule builder:
-
-```bash
-decision_agent web
+Or add to your Gemfile:
+```ruby
+gem 'decision_agent'
 ```
 
-Then open [http://localhost:4567](http://localhost:4567) in your browser.
-
-The Web UI provides:
-- 📝 **Visual rule creation** - Build rules using forms and dropdowns
-- 🔍 **Live validation** - Instant feedback on rule correctness
-- 📤 **Export/Import** - Download or upload rules as JSON
-- 📚 **Example templates** - Pre-built rule sets to get started
-- ✨ **No coding required** - Perfect for business analysts and domain experts
-
-See [WEB_UI.md](WEB_UI.md) for detailed documentation.
-
-<img width="1602" height="770" alt="Screenshot 2025-12-19 at 3 06 07 PM" src="https://github.com/user-attachments/assets/6ee6859c-f9f2-4f93-8bff-923986ccb1bc" />
-
-
 ## Quick Start
 
 ```ruby
 require 'decision_agent'
 
-# Define evaluators
-evaluator = DecisionAgent::Evaluators::StaticEvaluator.new(
-  decision: "approve",
-  weight: 0.8,
-  reason: "User meets basic criteria"
-)
-
-# Create agent
-agent = DecisionAgent::Agent.new(
-  evaluators: [evaluator],
-  scoring_strategy: DecisionAgent::Scoring::WeightedAverage.new,
-  audit_adapter: DecisionAgent::Audit::LoggerAdapter.new
-)
-
-# Make decision
-result = agent.decide(
-  context: { user: "alice", priority: "high" }
-)
-
-puts result.decision       # => "approve"
-puts result.confidence     # => 0.8
-puts result.explanations   # => ["Decision: approve (confidence: 0.8)", ...]
-puts result.audit_payload  # => Full audit trail
-```
-
-## Core Concepts
-
-### 1. Agent
-
-The orchestrator that coordinates evaluators, resolves conflicts, and produces decisions.
-
-```ruby
-agent = DecisionAgent::Agent.new(
-  evaluators: [eval1, eval2, eval3],
-  scoring_strategy: DecisionAgent::Scoring::WeightedAverage.new,
-  audit_adapter: DecisionAgent::Audit::NullAdapter.new
-)
-```
-
-### 2. Evaluators
-
-Pluggable components that evaluate context and return decisions.
-
-#### StaticEvaluator
-
-Always returns the same decision:
-
-```ruby
-evaluator = DecisionAgent::Evaluators::StaticEvaluator.new(
-  decision: "approve",
-  weight: 0.7,
-  reason: "Static approval rule"
-)
-```
-
-#### JsonRuleEvaluator
-
-Evaluates context against JSON-based business rules:
-
-```ruby
-rules = {
-  version: "1.0",
-  ruleset: "issue_triage",
-  rules: [
-    {
-      id: "high_priority_rule",
-      if: {
-        all: [
-          { field: "priority", op: "eq", value: "high" },
-          { field: "hours_inactive", op: "gte", value: 4 }
-        ]
-      },
-      then: {
-        decision: "escalate",
-        weight: 0.9,
-        reason: "High priority issue inactive too long"
-      }
-    }
-  ]
-}
-
+# Define evaluator with business rules
 evaluator = DecisionAgent::Evaluators::JsonRuleEvaluator.new(
-  rules_json: rules
-)
-```
-
-### 3. Context
-
-Immutable input data for decision-making:
-
-```ruby
-context = DecisionAgent::Context.new({
-  user: "alice",
-  priority: "high",
-  hours_inactive: 5
-})
-```
-
-### 4. Scoring Strategies
-
-Resolve conflicts when multiple evaluators return different decisions.
-
-#### WeightedAverage (Default)
-
-Sums weights for each decision, selects winner:
-
-```ruby
-DecisionAgent::Scoring::WeightedAverage.new
-```
-
-#### MaxWeight
-
-Selects decision with highest individual weight:
-
-```ruby
-DecisionAgent::Scoring::MaxWeight.new
-```
-
-#### Consensus
-
-Requires minimum agreement threshold:
-
-```ruby
-DecisionAgent::Scoring::Consensus.new(minimum_agreement: 0.6)
-```
-
-#### Threshold
-
-Requires minimum weight to accept decision:
-
-```ruby
-DecisionAgent::Scoring::Threshold.new(
-  threshold: 0.8,
-  fallback_decision: "manual_review"
+  rules_json: {
+    version: "1.0",
+    ruleset: "approval_rules",
+    rules: [{
+      id: "high_value",
+      if: { field: "amount", op: "gt", value: 1000 },
+      then: { decision: "approve", weight: 0.9, reason: "High value transaction" }
+    }]
+  }
 )
-```
-
-### 5. Audit Adapters
-
-Record decisions for compliance and debugging.
 
-#### NullAdapter
+# Create decision agent
+agent = DecisionAgent::Agent.new(evaluators: [evaluator])
 
-No-op (default):
-
-```ruby
-DecisionAgent::Audit::NullAdapter.new
-```
-
-#### LoggerAdapter
-
-Logs to any Ruby logger:
-
-```ruby
-DecisionAgent::Audit::LoggerAdapter.new(
-  logger: Rails.logger,
-  level: Logger::INFO
-)
-```
-
-## JSON Rule DSL
-
-### Supported Operators
-
-| Operator | Description | Example |
-|----------|-------------|---------|
-| `eq` | Equal | `{ field: "status", op: "eq", value: "active" }` |
-| `neq` | Not equal | `{ field: "status", op: "neq", value: "closed" }` |
-| `gt` | Greater than | `{ field: "score", op: "gt", value: 80 }` |
-| `gte` | Greater than or equal | `{ field: "hours", op: "gte", value: 4 }` |
-| `lt` | Less than | `{ field: "temp", op: "lt", value: 32 }` |
-| `lte` | Less than or equal | `{ field: "temp", op: "lte", value: 32 }` |
-| `in` | Array membership | `{ field: "status", op: "in", value: ["open", "pending"] }` |
-| `present` | Field exists and not empty | `{ field: "assignee", op: "present" }` |
-| `blank` | Field missing, nil, or empty | `{ field: "description", op: "blank" }` |
-
-### Condition Combinators
-
-#### all
-
-All sub-conditions must be true:
-
-```json
-{
-  "all": [
-    { "field": "priority", "op": "eq", "value": "high" },
-    { "field": "hours", "op": "gte", "value": 4 }
-  ]
-}
-```
-
-#### any
-
-At least one sub-condition must be true:
-
-```json
-{
-  "any": [
-    { "field": "escalated", "op": "eq", "value": true },
-    { "field": "complaints", "op": "gte", "value": 3 }
-  ]
-}
-```
-
-### Nested Fields
-
-Use dot notation to access nested data:
-
-```json
-{
-  "field": "user.role",
-  "op": "eq",
-  "value": "admin"
-}
-```
-
-```ruby
-context = DecisionAgent::Context.new({
-  user: { role: "admin" }
-})
-```
-
-### Complete Example
-
-```json
-{
-  "version": "1.0",
-  "ruleset": "redmine_triage",
-  "rules": [
-    {
-      "id": "critical_escalation",
-      "if": {
-        "all": [
-          { "field": "priority", "op": "eq", "value": "critical" },
-          {
-            "any": [
-              { "field": "hours_inactive", "op": "gte", "value": 2 },
-              { "field": "customer_escalated", "op": "eq", "value": true }
-            ]
-          }
-        ]
-      },
-      "then": {
-        "decision": "escalate_immediately",
-        "weight": 1.0,
-        "reason": "Critical issue requires immediate attention"
-      }
-    },
-    {
-      "id": "auto_assign",
-      "if": {
-        "all": [
-          { "field": "assignee", "op": "blank" },
-          { "field": "priority", "op": "in", "value": ["high", "critical"] }
-        ]
-      },
-      "then": {
-        "decision": "assign_to_team_lead",
-        "weight": 0.85,
-        "reason": "High priority issue needs assignment"
-      }
-    }
-  ]
-}
-```
-
-## Decision Replay
-
-Critical for compliance and debugging - replay any historical decision exactly.
-
-### Strict Mode
-
-Fails if replayed decision differs from original:
-
-```ruby
-original_result = agent.decide(context: { user: "alice" })
-
-# Later, replay the exact decision
-replayed_result = DecisionAgent::Replay.run(
-  original_result.audit_payload,
-  strict: true
-)
+# Make decision
+result = agent.decide(context: { amount: 1500 })
 
-# Raises ReplayMismatchError if decision changed
+puts result.decision      # => "approve"
+puts result.confidence    # => 0.9
+puts result.explanations  # => ["High value transaction"]
 ```
 
-### Non-Strict Mode
+## Web UI - Visual Rule Builder
 
-Logs differences but allows evolution:
+Launch the visual rule builder for non-technical users:
 
-```ruby
-replayed_result = DecisionAgent::Replay.run(
-  original_result.audit_payload,
-  strict: false  # Logs differences but doesn't fail
-)
-```
-
-### Audit Payload Structure
-
-```ruby
-{
-  timestamp: "2025-01-15T10:30:45.123456Z",
-  context: { user: "alice", priority: "high" },
-  feedback: {},
-  evaluations: [
-    {
-      decision: "approve",
-      weight: 0.8,
-      reason: "Rule matched",
-      evaluator_name: "JsonRuleEvaluator",
-      metadata: { rule_id: "high_priority_rule" }
-    }
-  ],
-  decision: "approve",
-  confidence: 0.8,
-  scoring_strategy: "DecisionAgent::Scoring::WeightedAverage",
-  agent_version: "0.1.0",
-  deterministic_hash: "a3f2b9c..."
-}
+```bash
+decision_agent web
 ```
 
-## Advanced Usage
-
-### Multiple Evaluators with Conflict Resolution
-
-```ruby
-rule_evaluator = DecisionAgent::Evaluators::JsonRuleEvaluator.new(
-  rules_json: File.read("rules/triage.json")
-)
-
-ml_evaluator = DecisionAgent::Evaluators::StaticEvaluator.new(
-  decision: "review_manually",
-  weight: 0.6,
-  reason: "ML model suggests manual review"
-)
-
+Open [http://localhost:4567](http://localhost:4567) in your browser.
+
+<img width="1602" alt="DecisionAgent Web UI" src="https://github.com/user-attachments/assets/6ee6859c-f9f2-4f93-8bff-923986ccb1bc" />
+
+## Documentation
+
+```
+📚 DecisionAgent Documentation
+│
+├── 🚀 Getting Started
+│   ├── Installation (above)
+│   ├── Quick Start (above)
+│   └── Examples → examples/README.md
+│
+├── 📖 Core Documentation
+│   ├── Core Concepts → wiki/CORE_CONCEPTS.md
+│   ├── JSON Rule DSL → wiki/JSON_RULE_DSL.md
+│   ├── API Reference → wiki/API_CONTRACT.md
+│   └── Error Handling → wiki/ERROR_HANDLING.md
+│
+├── 🎯 Advanced Features
+│   ├── Versioning System → wiki/VERSIONING.md
+│   ├── Decision Replay → wiki/REPLAY.md
+│   ├── Advanced Usage → wiki/ADVANCED_USAGE.md
+│   └── Custom Components → wiki/ADVANCED_USAGE.md#custom-components
+│
+├── 🔌 Integration Guides
+│   ├── Rails Integration → wiki/INTEGRATION.md#rails
+│   ├── Redmine Plugin → wiki/INTEGRATION.md#redmine
+│   ├── Standalone Service → wiki/INTEGRATION.md#standalone
+│   └── Testing Guide → wiki/TESTING.md
+│
+├── 🎨 Web UI
+│   ├── User Guide → wiki/WEB_UI.md
+│   └── Setup Guide → wiki/WEB_UI_SETUP.md
+│
+└── 📝 Reference
+    ├── Changelog → wiki/CHANGELOG.md
+    └── Full Wiki Index → wiki/README.md
+```
+
+## Key Features
+
+### Decision Making
+- **Multiple Evaluators** - Combine rule-based, ML, and custom logic
+- **Conflict Resolution** - Weighted average, consensus, threshold, max weight
+- **Rich Context** - Nested data, dot notation, flexible operators
+
+### Auditability
+- **Complete Audit Trails** - Every decision fully logged
+- **Deterministic Replay** - Reproduce historical decisions exactly
+- **Compliance Ready** - HIPAA, SOX, regulatory compliance support
+
+### Flexibility
+- **Pluggable Architecture** - Custom evaluators, scoring, audit adapters
+- **Framework Agnostic** - Works with Rails, Sinatra, or standalone
+- **JSON Rule DSL** - Non-technical users can write rules
+- **Visual Rule Builder** - Web UI for rule management
+
+### Production Ready
+- **Comprehensive Testing** - 90%+ code coverage
+- **Error Handling** - Clear, actionable error messages
+- **Versioning** - Full rule version control and rollback
+- **Performance** - Fast, zero external dependencies
+
+## Examples
+
+```ruby
+# Multiple evaluators with conflict resolution
 agent = DecisionAgent::Agent.new(
   evaluators: [rule_evaluator, ml_evaluator],
-  scoring_strategy: DecisionAgent::Scoring::Consensus.new(minimum_agreement: 0.7)
-)
-
-result = agent.decide(
-  context: { priority: "high", complexity: "high" }
-)
-
-# Explanations show how conflict was resolved
-puts result.explanations
-```
-
-### Custom Evaluator
-
-```ruby
-class CustomBusinessLogicEvaluator < DecisionAgent::Evaluators::Base
-  def evaluate(context, feedback: {})
-    # Your custom logic here
-    if context[:revenue] > 100_000 && context[:customer_tier] == "enterprise"
-      DecisionAgent::Evaluation.new(
-        decision: "approve_immediately",
-        weight: 0.95,
-        reason: "High-value enterprise customer",
-        evaluator_name: "EnterpriseCustomerEvaluator",
-        metadata: { tier: "enterprise" }
-      )
-    else
-      nil  # No decision
-    end
-  end
-end
-```
-
-### Custom Scoring Strategy
-
-```ruby
-class VetoScoring < DecisionAgent::Scoring::Base
-  def score(evaluations)
-    # If any evaluator says "reject", veto everything
-    if evaluations.any? { |e| e.decision == "reject" }
-      return { decision: "reject", confidence: 1.0 }
-    end
-
-    # Otherwise, use max weight
-    max_eval = evaluations.max_by(&:weight)
-    {
-      decision: max_eval.decision,
-      confidence: normalize_confidence(max_eval.weight)
-    }
-  end
-end
-
-agent = DecisionAgent::Agent.new(
-  evaluators: [...],
-  scoring_strategy: VetoScoring.new
-)
-```
-
-### Custom Audit Adapter
-
-```ruby
-class DatabaseAuditAdapter < DecisionAgent::Audit::Adapter
-  def record(decision, context)
-    AuditLog.create!(
-      decision: decision.decision,
-      confidence: decision.confidence,
-      context_json: context.to_h.to_json,
-      audit_payload: decision.audit_payload.to_json,
-      deterministic_hash: decision.audit_payload[:deterministic_hash]
-    )
-  end
-end
-```
-
-### Feedback Loop
-
-The `feedback` parameter allows you to pass additional context about past decisions, manual overrides, or external signals that can influence decision-making in custom evaluators.
-
-#### Built-in Evaluators and Feedback
-
-**Built-in evaluators** (`JsonRuleEvaluator`, `StaticEvaluator`) **ignore feedback** to maintain determinism. This is intentional - the same context should always produce the same decision for auditability and replay purposes.
-
-```ruby
-# Feedback is accepted but not used by built-in evaluators
-result = agent.decide(
-  context: { issue_id: 123 },
-  feedback: { source: "automated", past_accuracy: 0.95 }
-)
-
-# The feedback is stored in the audit trail for analysis
-puts result.audit_payload[:feedback]  # => { source: "automated", past_accuracy: 0.95 }
-```
-
-#### Custom Feedback-Aware Evaluators
-
-For **adaptive behavior**, create custom evaluators that use feedback:
-
-```ruby
-# See examples/feedback_aware_evaluator.rb for a complete implementation
-class FeedbackAwareEvaluator < DecisionAgent::Evaluators::Base
-  def evaluate(context, feedback: {})
-    # Use feedback to adjust decisions
-    if feedback[:override]
-      return Evaluation.new(
-        decision: feedback[:override],
-        weight: 0.9,
-        reason: feedback[:reason] || "Manual override",
-        evaluator_name: evaluator_name
-      )
-    end
-
-    # Or adjust confidence based on past accuracy
-    adjusted_weight = base_weight * feedback[:past_accuracy].to_f
-
-    Evaluation.new(
-      decision: base_decision,
-      weight: adjusted_weight,
-      reason: "Adjusted by past performance",
-      evaluator_name: evaluator_name
-    )
-  end
-end
-```
-
-#### Common Feedback Patterns
-
-1. **Manual Override**: Human-in-the-loop corrections
-   ```ruby
-   agent.decide(
-     context: { user_id: 123 },
-     feedback: { override: "manual_review", reason: "Suspicious activity" }
-   )
-   ```
-
-2. **Historical Performance**: Adjust confidence based on past accuracy
-   ```ruby
-   agent.decide(
-     context: { transaction: tx },
-     feedback: { past_accuracy: 0.87 }  # This evaluator was 87% accurate historically
-   )
-   ```
-
-3. **Source Attribution**: Weight decisions differently based on origin
-   ```ruby
-   agent.decide(
-     context: { issue: issue },
-     feedback: { source: "expert_review" }  # Higher confidence for expert reviews
-   )
-   ```
-
-4. **Learning Signals**: Collect data for offline model training
-   ```ruby
-   # Initial decision
-   result = agent.decide(context: { user: user })
-
-   # Later: user provides feedback
-   user_feedback = {
-     correct: false,
-     actual_decision: "escalate",
-     user_id: "manager_bob",
-     timestamp: Time.now.utc.iso8601
-   }
-
-   # Log for analysis and future rule adjustments
-   # (DecisionAgent doesn't auto-update rules - this is for your ML/analysis pipeline)
-   FeedbackLog.create(
-     decision_hash: result.audit_payload[:deterministic_hash],
-     predicted: result.decision,
-     actual: user_feedback[:actual_decision],
-     feedback: user_feedback
-   )
-   ```
-
-#### Example: Complete Feedback-Aware System
-
-See [examples/feedback_aware_evaluator.rb](examples/feedback_aware_evaluator.rb) for a complete example that demonstrates:
-- Manual overrides with high confidence
-- Past accuracy-based weight adjustment
-- Source-based confidence boosting
-- Comprehensive metadata tracking
-
-**Key Principle**: Use feedback for **human oversight** and **continuous improvement**, but keep the core decision logic deterministic and auditable.
-
-## Integration Examples
-
-### Rails Integration
-
-```ruby
-# app/services/issue_decision_service.rb
-class IssueDecisionService
-  def self.decide_action(issue)
-    agent = build_agent
-
-    result = agent.decide(
-      context: {
-        priority: issue.priority,
-        hours_inactive: (Time.now - issue.updated_at) / 3600,
-        assignee: issue.assignee&.login,
-        status: issue.status
-      }
-    )
-
-    result
-  end
-
-  private
-
-  def self.build_agent
-    rules = JSON.parse(File.read(Rails.root.join("config/rules/issue_triage.json")))
-
-    DecisionAgent::Agent.new(
-      evaluators: [
-        DecisionAgent::Evaluators::JsonRuleEvaluator.new(rules_json: rules)
-      ],
-      scoring_strategy: DecisionAgent::Scoring::WeightedAverage.new,
-      audit_adapter: DecisionAgent::Audit::LoggerAdapter.new(logger: Rails.logger)
-    )
-  end
-end
-```
-
-### Redmine Plugin Integration
-
-```ruby
-# plugins/redmine_smart_triage/lib/decision_engine.rb
-module RedmineSmartTriage
-  class DecisionEngine
-    def self.evaluate_issue(issue)
-      agent = build_agent
-
-      context = {
-        "priority" => issue.priority.name.downcase,
-        "status" => issue.status.name.downcase,
-        "hours_inactive" => hours_since_update(issue),
-        "assignee" => issue.assigned_to&.login,
-        "tracker" => issue.tracker.name.downcase
-      }
-
-      agent.decide(context: context)
-    end
-
-    private
-
-    def self.build_agent
-      rules_path = File.join(File.dirname(__FILE__), "../config/triage_rules.json")
-      rules = JSON.parse(File.read(rules_path))
-
-      DecisionAgent::Agent.new(
-        evaluators: [
-          DecisionAgent::Evaluators::JsonRuleEvaluator.new(rules_json: rules)
-        ],
-        audit_adapter: RedmineAuditAdapter.new
-      )
-    end
-
-    def self.hours_since_update(issue)
-      ((Time.now - issue.updated_on) / 3600).round
-    end
-  end
-
-  class RedmineAuditAdapter < DecisionAgent::Audit::Adapter
-    def record(decision, context)
-      # Store in Redmine custom field or separate table
-      Rails.logger.info "[DecisionAgent] #{decision.decision} (confidence: #{decision.confidence})"
-    end
-  end
-end
-```
-
-### Standalone Service
-
-```ruby
-#!/usr/bin/env ruby
-require 'decision_agent'
-require 'json'
-
-# Load rules
-rules = JSON.parse(File.read("config/rules.json"))
-
-# Build agent
-agent = DecisionAgent::Agent.new(
-  evaluators: [
-    DecisionAgent::Evaluators::JsonRuleEvaluator.new(rules_json: rules)
-  ],
-  scoring_strategy: DecisionAgent::Scoring::Threshold.new(
-    threshold: 0.75,
-    fallback_decision: "manual_review"
-  ),
+  scoring_strategy: DecisionAgent::Scoring::Consensus.new(minimum_agreement: 0.7),
   audit_adapter: DecisionAgent::Audit::LoggerAdapter.new
 )
 
-# Read context from stdin
-context = JSON.parse(STDIN.read)
-
-# Decide
-result = agent.decide(context: context)
-
-# Output decision
-output = {
-  decision: result.decision,
-  confidence: result.confidence,
-  explanations: result.explanations
+# Complex rules with nested conditions
+rules = {
+  version: "1.0",
+  ruleset: "fraud_detection",
+  rules: [{
+    id: "suspicious_activity",
+    if: {
+      all: [
+        { field: "amount", op: "gt", value: 10000 },
+        { any: [
+          { field: "user.country", op: "in", value: ["XX", "YY"] },
+          { field: "velocity", op: "gt", value: 5 }
+        ]}
+      ]
+    },
+    then: { decision: "flag_for_review", weight: 0.95, reason: "Suspicious patterns detected" }
+  }]
 }
-
-puts JSON.pretty_generate(output)
-```
-
-## Design Philosophy
-
-### Why Deterministic > AI
-
-1. **Regulatory Compliance**: Healthcare (HIPAA), finance (SOX), and government require auditable, explainable decisions
-2. **Cost**: Rules are free to evaluate; LLM calls cost money and add latency
-3. **Reliability**: Same input must produce same output for testing and legal defensibility
-4. **Transparency**: Business rules are explicit and reviewable by domain experts
-5. **AI Enhancement**: AI can suggest rule adjustments, but rules make final decisions
-
-### When to Use DecisionAgent
-
-- **Regulated domains**: Healthcare, finance, legal, government
-- **Business rule engines**: Complex decision trees with multiple evaluators
-- **Compliance requirements**: Need full audit trails and decision replay
-- **Explainability required**: Humans must understand why decisions were made
-- **Deterministic systems**: Same input must always produce same output
-
-### When NOT to Use
-
-- Simple if/else logic (just use Ruby)
-- Purely AI-driven decisions with no rules
-- Single-step validations (use standard validation libraries)
-
-## Testing
-
-```ruby
-# spec/my_decision_spec.rb
-RSpec.describe "My Decision Logic" do
-  it "escalates critical issues" do
-    rules = { ... }
-    evaluator = DecisionAgent::Evaluators::JsonRuleEvaluator.new(rules_json: rules)
-    agent = DecisionAgent::Agent.new(evaluators: [evaluator])
-
-    result = agent.decide(
-      context: { priority: "critical", hours_inactive: 3 }
-    )
-
-    expect(result.decision).to eq("escalate")
-    expect(result.confidence).to be > 0.8
-  end
-end
-```
-
-## Error Handling
-
-All errors are namespaced under `DecisionAgent`:
-
-### NoEvaluationsError
-
-Raised when no evaluator returns a decision (all returned `nil` or raised exceptions).
-
-```ruby
-begin
-  agent.decide(context: {})
-rescue DecisionAgent::NoEvaluationsError => e
-  # No evaluator returned a decision
-  puts e.message  # => "No evaluators returned a decision"
-
-  # Handle gracefully
-  fallback_decision = "manual_review"
-end
-```
-
-### InvalidRuleDslError
-
-Raised when JSON rule DSL is malformed or invalid.
-
-```ruby
-begin
-  rules = { invalid: "structure" }
-  evaluator = DecisionAgent::Evaluators::JsonRuleEvaluator.new(rules_json: rules)
-rescue DecisionAgent::InvalidRuleDslError => e
-  # JSON rule DSL is malformed
-  puts e.message  # => "Invalid rule DSL structure"
-end
 ```
 
-### ReplayMismatchError
+See [examples/](examples/) for complete working examples.
 
-Raised in strict replay mode when replayed decision differs from original.
+## When to Use DecisionAgent
 
-```ruby
-begin
-  replayed_result = DecisionAgent::Replay.run(audit_payload, strict: true)
-rescue DecisionAgent::ReplayMismatchError => e
-  # Replay produced different result
-  puts "Expected: #{e.expected}"  # => "approve"
-  puts "Actual: #{e.actual}"      # => "reject"
-  puts "Differences: #{e.differences}"  # => ["decision changed", "confidence changed"]
-end
-```
-
-### InvalidConfidenceError
-
-Raised when confidence value is outside [0.0, 1.0] range.
-
-```ruby
-begin
-  decision = DecisionAgent::Decision.new(
-    decision: "approve",
-    confidence: 1.5,  # Invalid!
-    explanations: [],
-    evaluations: [],
-    audit_payload: {}
-  )
-rescue DecisionAgent::InvalidConfidenceError => e
-  puts e.message  # => "Confidence must be between 0.0 and 1.0, got: 1.5"
-end
-```
-
-### InvalidWeightError
-
-Raised when evaluation weight is outside [0.0, 1.0] range.
-
-```ruby
-begin
-  eval = DecisionAgent::Evaluation.new(
-    decision: "approve",
-    weight: -0.5,  # Invalid!
-    reason: "Test",
-    evaluator_name: "Test"
-  )
-rescue DecisionAgent::InvalidWeightError => e
-  puts e.message  # => "Weight must be between 0.0 and 1.0, got: -0.5"
-end
-```
-
-### Configuration Errors
-
-Raised during agent initialization when configuration is invalid.
-
-```ruby
-begin
-  # No evaluators provided
-  agent = DecisionAgent::Agent.new(evaluators: [])
-rescue DecisionAgent::InvalidConfigurationError => e
-  puts e.message  # => "At least one evaluator is required"
-end
-
-begin
-  # Invalid evaluator
-  agent = DecisionAgent::Agent.new(evaluators: ["not an evaluator"])
-rescue DecisionAgent::InvalidEvaluatorError => e
-  puts e.message  # => "Evaluator must respond to #evaluate"
-end
-```
-
-## API Reference
-
-### Agent
-
-Main orchestrator for decision-making.
-
-**Constructor:**
-```ruby
-DecisionAgent::Agent.new(
-  evaluators: [evaluator1, evaluator2],
-  scoring_strategy: DecisionAgent::Scoring::WeightedAverage.new,  # Optional, defaults to WeightedAverage
-  audit_adapter: DecisionAgent::Audit::NullAdapter.new            # Optional, defaults to NullAdapter
-)
-```
-
-**Public Methods:**
-
-- `#decide(context:, feedback: {})` → `Decision`
-  - Makes a decision based on context and optional feedback
-  - Raises `NoEvaluationsError` if no evaluators return decisions
-  - Returns a `Decision` object with decision, confidence, and explanations
-
-**Attributes:**
-- `#evaluators` → `Array` - Read-only access to configured evaluators
-- `#scoring_strategy` → `Scoring::Base` - Read-only access to scoring strategy
-- `#audit_adapter` → `Audit::Adapter` - Read-only access to audit adapter
-
-### Decision
-
-Immutable result object representing a decision.
-
-**Constructor:**
-```ruby
-DecisionAgent::Decision.new(
-  decision: "approve",
-  confidence: 0.85,
-  explanations: ["High priority rule matched"],
-  evaluations: [evaluation1, evaluation2],
-  audit_payload: {...}
-)
-```
-
-**Attributes:**
-- `#decision` → `String` - The final decision (frozen)
-- `#confidence` → `Float` - Confidence score between 0.0 and 1.0
-- `#explanations` → `Array<String>` - Human-readable explanations (frozen)
-- `#evaluations` → `Array<Evaluation>` - All evaluations that contributed (frozen)
-- `#audit_payload` → `Hash` - Complete audit trail for replay (frozen)
-
-**Public Methods:**
-
-- `#to_h` → `Hash` - Converts to hash representation
-- `#==(other)` → `Boolean` - Equality comparison (compares decision, confidence, explanations, evaluations)
-
-### Evaluation
-
-Immutable result from a single evaluator.
-
-**Constructor:**
-```ruby
-DecisionAgent::Evaluation.new(
-  decision: "approve",
-  weight: 0.8,
-  reason: "User meets criteria",
-  evaluator_name: "MyEvaluator",
-  metadata: { rule_id: "R1" }  # Optional, defaults to {}
-)
-```
-
-**Attributes:**
-- `#decision` → `String` - The evaluator's decision (frozen)
-- `#weight` → `Float` - Weight between 0.0 and 1.0
-- `#reason` → `String` - Human-readable reason (frozen)
-- `#evaluator_name` → `String` - Name of the evaluator (frozen)
-- `#metadata` → `Hash` - Additional context (frozen)
-
-**Public Methods:**
-
-- `#to_h` → `Hash` - Converts to hash representation
-- `#==(other)` → `Boolean` - Equality comparison
-
-### Context
-
-Immutable wrapper for decision context data.
-
-**Constructor:**
-```ruby
-DecisionAgent::Context.new(
-  user: "alice",
-  priority: "high",
-  nested: { role: "admin" }
-)
-```
-
-**Public Methods:**
-
-- `#[]` → `Object` - Access context value by key (supports both string and symbol keys)
-- `#to_h` → `Hash` - Returns underlying hash (frozen)
-- `#==(other)` → `Boolean` - Equality comparison
-
-### Evaluators::Base
-
-Base class for custom evaluators.
-
-**Public Methods:**
-
-- `#evaluate(context, feedback: {})` → `Evaluation | nil`
-  - Must be implemented by subclasses
-  - Returns `Evaluation` if a decision is made, `nil` otherwise
-  - `context` is a `Context` object
-  - `feedback` is an optional hash
-
-### Scoring::Base
-
-Base class for custom scoring strategies.
-
-**Public Methods:**
-
-- `#score(evaluations)` → `{ decision: String, confidence: Float }`
-  - Must be implemented by subclasses
-  - Takes array of `Evaluation` objects
-  - Returns hash with `:decision` and `:confidence` keys
-  - Confidence must be between 0.0 and 1.0
-
-**Protected Methods:**
-- `#normalize_confidence(value)` → `Float` - Clamps value to [0.0, 1.0]
-- `#round_confidence(value)` → `Float` - Rounds to 4 decimal places
+✅ **Perfect for:**
+- Regulated industries (healthcare, finance, legal)
+- Complex business rule engines
+- Audit trail requirements
+- Explainable AI systems
+- Multi-step decision workflows
 
-### Audit::Adapter
-
-Base class for custom audit adapters.
-
-**Public Methods:**
-
-- `#record(decision, context)` → `void`
-  - Must be implemented by subclasses
-  - Called after each decision is made
-  - `decision` is a `Decision` object
-  - `context` is a `Context` object
-
-### Replay
-
-Utilities for replaying historical decisions.
-
-**Class Methods:**
-
-- `DecisionAgent::Replay.run(audit_payload, strict: true)` → `Decision`
-  - Replays a decision from audit payload
-  - `strict: true` raises `ReplayMismatchError` on differences
-  - `strict: false` logs differences but allows evolution
-
-## Versioning
-
-DecisionAgent follows [Semantic Versioning 2.0.0](https://semver.org/):
-
-- **MAJOR** version for incompatible API changes
-- **MINOR** version for backwards-compatible functionality additions
-- **PATCH** version for backwards-compatible bug fixes
-
-### Stability Guarantees
-
-- **Public API**: All classes and methods documented in this README are stable
-- **Audit Payload Format**: The structure of `audit_payload` is stable and will remain replayable across versions
-- **Deterministic Hash**: The algorithm for computing `deterministic_hash` is frozen to ensure replay compatibility
-- **Breaking Changes**: Will only occur in major version bumps, with clear migration guides
-
-### Deprecation Policy
-
-- Deprecated features will be marked in documentation and emit warnings
-- Deprecated features will be maintained for at least one minor version before removal
-- Breaking changes will be documented in CHANGELOG.md with migration instructions
+❌ **Not suitable for:**
+- Simple if/else logic (use plain Ruby)
+- Pure AI/ML with no rules
+- Single-step validations
 
 ## Contributing
 
 1. Fork the repository
 2. Create a feature branch
 3. Add tests (maintain 90%+ coverage)
-4. Ensure all tests pass: `rspec`
-5. Submit a pull request
-
-## License
+4. Submit a pull request
 
-MIT License. See [LICENSE.txt](LICENSE.txt).
-
-## Roadmap
+## Support
 
-- [x] Rule validation CLI ✓
-- [x] Web UI for rule editing ✓
-- [ ] Performance benchmarks
-- [ ] Prometheus metrics adapter
-- [ ] Additional scoring strategies (Bayesian, etc.)
-- [ ] AI evaluator adapter (optional, non-deterministic mode)
+- **Issues**: [GitHub Issues](https://github.com/samaswin87/decision_agent/issues)
+- **Documentation**: [Wiki](wiki/README.md)
+- **Examples**: [examples/](examples/)
 
-## Support
+## License
 
-- GitHub Issues: [https://github.com/samaswin87/decision_agent/issues](https://github.com/samaswin87/decision_agent/issues)
-- Documentation: [https://github.com/samaswin87/decision_agent](https://github.com/samaswin87/decision_agent)
+MIT License - see [LICENSE.txt](LICENSE.txt)
 
 ---
 
-**Built for regulated domains. Deterministic by design. AI-optional.**
+⭐ **Star this repo** if you find it useful!