testarch review

* feat: migrate test architect entirely to v6

* format fixed

* feat: integrated new playwright mcp

---------

Co-authored-by: Murat Ozcan <murat@mac.lan>

.github/FUNDING.yaml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project_name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project_name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: bmad
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps to Reproduce**
+What lead to the bug and can it be reliable recreated - if so with what steps.
+
+**PR**
+If you have an idea to fix and would like to contribute, please indicate here you are working on a fix, or link to a proposed PR to fix the issue. Please review the contribution.md - contributions are always welcome!
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Please be Specific if relevant**
+Model(s) Used:
+Agentic IDE Used:
+WebSite Used:
+Project Language:
+BMad Method version:
+
+**Screenshots or Links**
+If applicable, add screenshots or links (if web sharable record) to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here. The more information you can provide, the easier it will be to suggest a fix or resolve

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discord Community Support
+    url: https://discord.gg/gk8jAdXWmj
+    about: Please join our Discord server for general questions and community discussion before opening an issue.

.github/ISSUE_TEMPLATE/idea_submission.md

@@ -0,0 +1,109 @@
+---
+name: V6 Idea Submission
+about: Suggest an idea for v6
+title: ''
+labels: ''
+assignees: ''
+---
+
+# Idea: [Replace with a clear, actionable title]
+
+### PASS Framework
+
+**P**roblem:
+
+> What's broken or missing? What pain point are we addressing? (1-2 sentences)
+>
+> [Your answer here]
+
+**A**udience:
+
+> Who's affected by this problem and how severely? (1-2 sentences)
+>
+> [Your answer here]
+
+**S**olution:
+
+> What will we build or change? How will we measure success? (1-2 sentences with at least 1 measurable outcome)
+>
+> [Your answer here]
+>
+> [Your Acceptance Criteria for measuring success here]
+
+**S**ize:
+
+> How much effort do you estimate this will take?
+>
+> - [ ] **XS** - A few hours
+> - [ ] **S** - 1-2 days
+> - [ ] **M** - 3-5 days
+> - [ ] **L** - 1-2 weeks
+> - [ ] **XL** - More than 2 weeks
+
+---
+
+### Metadata
+
+**Submitted by:** [Your name]  
+**Date:** [Today's date]  
+**Priority:** [Leave blank - will be assigned during team review]
+
+---
+
+## Examples
+
+<details>
+<summary>Click to see a GOOD example</summary>
+
+### Idea: Add search functionality to customer dashboard
+
+**P**roblem:  
+Customers can't find their past orders quickly. They have to scroll through pages of orders to find what they're looking for, leading to 15+ support tickets per week.
+
+**A**udience:  
+All 5,000+ active customers are affected. Support team spends ~10 hours/week helping customers find orders.
+
+**S**olution:  
+Add a search bar that filters by order number, date range, and product name. Success = 50% reduction in order-finding support tickets within 2 weeks of launch.
+
+**S**ize:
+
+- [x] **M** - 3-5 days
+
+</details>
+
+<details>
+<summary>Click to see a POOR example</summary>
+
+### Idea: Make the app better
+
+**P**roblem:  
+The app needs improvements and updates.
+
+**A**udience:  
+Users
+
+**S**olution:  
+Fix issues and add features.
+
+**S**ize:
+
+- [ ] Unknown
+
+_Why this is poor: Too vague, no specific problem identified, no measurable success criteria, unclear scope_
+
+</details>****
+
+---
+
+## Tips for Success
+
+1. **Be specific** - Vague problems lead to vague solutions
+2. **Quantify when possible** - Numbers help us prioritize (e.g., "20 customers asked for this" vs "customers want this")
+3. **One idea per submission** - If you have multiple ideas, submit multiple templates
+4. **Success metrics matter** - How will we know this worked?
+5. **Honest sizing** - Better to overestimate than underestimate
+
+## Questions?
+
+Reach out to @OverlordBaconPants if you need help completing this template.

.github/workflows/discord.yaml

@@ -0,0 +1,16 @@
+name: Discord Notification
+
+"on": [pull_request, release, create, delete, issue_comment, pull_request_review, pull_request_review_comment]
+
+jobs:
+  notify:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify Discord
+        uses: sarisia/actions-status-discord@v1
+        if: always()
+        with:
+          webhook: ${{ secrets.DISCORD_WEBHOOK }}
+          status: ${{ job.status }}
+          title: "Triggered by ${{ github.event_name }}"
+          color: 0x5865F2

.github/workflows/format-check.yaml

@@ -0,0 +1,43 @@
+name: format-check
+
+"on":
+  pull_request:
+    branches: ["**"]
+  workflow_dispatch:
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Prettier format check
+        run: npm run format:check
+
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: ESLint
+        run: npm run lint

.github/workflows/manual-release.yaml

@@ -0,0 +1,173 @@
+name: Manual Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version_bump:
+        description: Version bump type
+        required: true
+        default: patch
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests and validation
+        run: |
+          npm run validate
+          npm run format:check
+          npm run lint
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version
+        run: npm run version:${{ github.event.inputs.version_bump }}
+
+      - name: Get new version and previous tag
+        id: version
+        run: |
+          echo "new_version=$(node -p "require('./package.json').version")" >> $GITHUB_OUTPUT
+          echo "previous_tag=$(git describe --tags --abbrev=0)" >> $GITHUB_OUTPUT
+
+      - name: Update installer package.json
+        run: |
+          sed -i 's/"version": ".*"/"version": "${{ steps.version.outputs.new_version }}"/' tools/installer/package.json
+
+      - name: Build project
+        run: npm run build
+
+      - name: Commit version bump
+        run: |
+          git add .
+          git commit -m "release: bump to v${{ steps.version.outputs.new_version }}"
+
+      - name: Generate release notes
+        id: release_notes
+        run: |
+          # Get commits since last tag
+          COMMITS=$(git log ${{ steps.version.outputs.previous_tag }}..HEAD --pretty=format:"- %s" --reverse)
+
+          # Categorize commits
+          FEATURES=$(echo "$COMMITS" | grep -E "^- (feat|Feature)" || true)
+          FIXES=$(echo "$COMMITS" | grep -E "^- (fix|Fix)" || true)  
+          CHORES=$(echo "$COMMITS" | grep -E "^- (chore|Chore)" || true)
+          OTHERS=$(echo "$COMMITS" | grep -v -E "^- (feat|Feature|fix|Fix|chore|Chore|release:|Release:)" || true)
+
+          # Build release notes
+          cat > release_notes.md << 'EOF'
+          ## 🚀 What's New in v${{ steps.version.outputs.new_version }}
+
+          EOF
+
+          if [ ! -z "$FEATURES" ]; then
+            echo "### ✨ New Features" >> release_notes.md
+            echo "$FEATURES" >> release_notes.md
+            echo "" >> release_notes.md
+          fi
+
+          if [ ! -z "$FIXES" ]; then
+            echo "### 🐛 Bug Fixes" >> release_notes.md
+            echo "$FIXES" >> release_notes.md
+            echo "" >> release_notes.md
+          fi
+
+          if [ ! -z "$OTHERS" ]; then
+            echo "### 📦 Other Changes" >> release_notes.md
+            echo "$OTHERS" >> release_notes.md
+            echo "" >> release_notes.md
+          fi
+
+          if [ ! -z "$CHORES" ]; then
+            echo "### 🔧 Maintenance" >> release_notes.md
+            echo "$CHORES" >> release_notes.md
+            echo "" >> release_notes.md
+          fi
+
+          cat >> release_notes.md << 'EOF'
+
+          ## 📦 Installation
+
+          ```bash
+          npx bmad-method install
+          ```
+
+          **Full Changelog**: https://github.com/bmad-code-org/BMAD-METHOD/compare/${{ steps.version.outputs.previous_tag }}...v${{ steps.version.outputs.new_version }}
+          EOF
+
+          # Output for GitHub Actions
+          echo "RELEASE_NOTES<<EOF" >> $GITHUB_OUTPUT
+          cat release_notes.md >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create and push tag
+        run: |
+          # Check if tag already exists
+          if git rev-parse "v${{ steps.version.outputs.new_version }}" >/dev/null 2>&1; then
+            echo "Tag v${{ steps.version.outputs.new_version }} already exists, skipping tag creation"
+          else
+            git tag -a "v${{ steps.version.outputs.new_version }}" -m "Release v${{ steps.version.outputs.new_version }}"
+            git push origin "v${{ steps.version.outputs.new_version }}"
+          fi
+
+      - name: Push changes to main
+        run: |
+          if git push origin HEAD:main 2>/dev/null; then
+            echo "✅ Successfully pushed to main branch"
+          else
+            echo "⚠️ Could not push to main (protected branch). This is expected."
+            echo "📝 Version bump and tag were created successfully."
+          fi
+
+      - name: Publish to NPM
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ steps.version.outputs.new_version }}
+          release_name: "BMad Method v${{ steps.version.outputs.new_version }}"
+          body: ${{ steps.release_notes.outputs.RELEASE_NOTES }}
+          draft: false
+          prerelease: false
+
+      - name: Summary
+        run: |
+          echo "🎉 Successfully released v${{ steps.version.outputs.new_version }}!"
+          echo "📦 Published to NPM with @latest tag"
+          echo "🏷️ Git tag: v${{ steps.version.outputs.new_version }}"
+          echo "✅ Users running 'npx bmad-method install' will now get version ${{ steps.version.outputs.new_version }}"
+          echo ""
+          echo "📝 Release notes preview:"
+          cat release_notes.md

.gitignore

@@ -1,21 +1,62 @@
-# Node modules
+# Dependencies
 node_modules/
+pnpm-lock.yaml
+bun.lock
+deno.lock
+pnpm-workspace.yaml
+package-lock.json
+
+
+test-output/*
 
 # Logs
-logs
+logs/
 *.log
 npm-debug.log*
 
 # Build output
-dist/
-build/
-
-# System files
-.DS_Store
+build/*.txt
 
 # Environment variables
 .env
 
-# VSCode settings
-.vscode/
-CLAUDE.md
+# System files
+.DS_Store
+Thumbs.db
+
+# Development tools and configs
+.prettierignore
+.prettierrc
+
+# IDE and editor configs
+.windsurf/
+.trae/
+.bmad*/.cursor/
+
+# AI assistant files
+CLAUDE.md
+.ai/*
+.claude
+cursor
+.gemini
+.mcp.json
+CLAUDE.local.md
+.serena/
+
+# Project-specific
+.bmad-core
+.bmad-creator-tools
+test-project-install/*
+sample-project/*
+flattened-codebase.xml
+*.stats.md
+.internal-docs/
+#UAT template testing output files
+tools/template-test-generator/test-scenarios/
+
+# Bundler temporary files
+.bundler-temp/
+
+# Test Install Output
+
+z*/

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+npx --no-install lint-staged

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org

.nvmrc

@@ -0,0 +1 @@
+22

.vscode/settings.json

@@ -0,0 +1,94 @@
+{
+  "chat.agent.enabled": true,
+  "chat.agent.maxRequests": 15,
+  "github.copilot.chat.agent.runTasks": true,
+  "chat.mcp.discovery.enabled": {
+    "claude-desktop": true,
+    "windsurf": true,
+    "cursor-global": true,
+    "cursor-workspace": true
+  },
+  "github.copilot.chat.agent.autoFix": true,
+  "chat.tools.autoApprove": false,
+  "cSpell.words": [
+    "Agentic",
+    "atlasing",
+    "Biostatistician",
+    "bmad",
+    "Cordova",
+    "customresourcedefinitions",
+    "dashboarded",
+    "Decisioning",
+    "eksctl",
+    "elicitations",
+    "filecomplete",
+    "fintech",
+    "fluxcd",
+    "frontmatter",
+    "gamedev",
+    "gitops",
+    "implementability",
+    "Improv",
+    "inclusivity",
+    "ingressgateway",
+    "istioctl",
+    "metroidvania",
+    "NACLs",
+    "nodegroup",
+    "platformconfigs",
+    "Playfocus",
+    "playtesting",
+    "pointerdown",
+    "pointerup",
+    "Polyrepo",
+    "replayability",
+    "roguelike",
+    "roomodes",
+    "Runbook",
+    "runbooks",
+    "Shardable",
+    "Softlock",
+    "solutioning",
+    "speedrunner",
+    "substep",
+    "tekton",
+    "tilemap",
+    "tileset",
+    "tmpl",
+    "Trae",
+    "VNET"
+  ],
+  "json.schemas": [
+    {
+      "fileMatch": ["package.json"],
+      "url": "https://json.schemastore.org/package.json"
+    },
+    {
+      "fileMatch": [".vscode/settings.json"],
+      "url": "vscode://schemas/settings/folder"
+    }
+  ],
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "yaml.format.enable": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "editor.rulers": [140],
+  "[xml]": {
+    "editor.defaultFormatter": "redhat.vscode-xml"
+  },
+  "xml.format.maxLineWidth": 140
+}

CHANGELOG.md

@@ -0,0 +1,326 @@
+# Changelog
+
+## [Unreleased]
+
+### Codex Installer
+
+- Codex installer uses custom prompts in `.codex/prompts/`, instead of `AGENTS.md`
+
+## [6.0.0-alpha.0]
+
+**Release: September 28, 2025**
+
+Initial alpha release of a major rewrite and overhaul improvement of past versions.
+
+### Major New Features
+
+- **Lean Core**: The core of BMad is very simple - common tasks that apply to any future module or agents, along with common agents that will be added to any modules - bmad-web-orchestrator and bmad-master.
+- **BMad Method**: The new BMad Method (AKA bmm) is a complete overhaul of the v4 method, now a fully scale adaptive rewrite. The workflow now scales from small enhancements to massive undertakings across multiple services or architectures, supporting a new vast array of project type, including a full subclass of game development specifics.
+- **BoMB**: The BMad Builder (AKA BoMB) now is able to fully automate creation and conversion of expansion packs from v5 to modules in v5 along with the net new ideation and brainstorming through implementation and testing of net new Modules, Workflows (were tasks and templates), Module Agents, and Standalone Personal Agents
+- **CIS**: The Creative Intelligence Suite (AKA CIS)
+
+## [v5.0.0] - SKIPPED
+
+**Note**: Version 5.0.0 was skipped due to NPX registry issues that corrupted the version. Development continues with v6.0.0-alpha.0.
+
+## [v4.43.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v4.43.0)
+
+**Release: August-September 2025 (v4.31.0 - v4.43.1)**
+
+Focus on stability, ecosystem growth, and professional tooling.
+
+### Major Integrations
+
+- **Codex CLI & Web**: Full Codex integration with web and CLI modes
+- **Auggie CLI**: Augment Code integration
+- **iFlow CLI**: iFlow support in installer
+- **Gemini CLI Custom Commands**: Enhanced Gemini CLI capabilities
+
+### Expansion Packs
+
+- **Godot Game Development**: Complete game dev workflow
+- **Creative Writing**: Professional writing agent system
+- **Agent System Templates**: Template expansion pack (Part 2)
+
+### Advanced Features
+
+- **AGENTS.md Generation**: Auto-generated agent documentation
+- **NPM Script Injection**: Automatic package.json updates
+- **File Exclusion**: `.bmad-flattenignore` support for flattener
+- **JSON-only Integration**: Compact integration mode
+
+### Quality & Stability
+
+- **PR Validation Workflow**: Automated contribution checks
+- **Fork-Friendly CI/CD**: Opt-in mechanism for forks
+- **Code Formatting**: Prettier integration with pre-commit hooks
+- **Update Checker**: `npx bmad-method update-check` command
+
+### Flattener Improvements
+
+- Detailed statistics with emoji-enhanced `.stats.md`
+- Improved project root detection
+- Modular component architecture
+- Binary directory exclusions (venv, node_modules, etc.)
+
+### Documentation & Community
+
+- Brownfield document naming consistency fixes
+- Architecture template improvements
+- Trademark and licensing clarity
+- Contributing guidelines refinement
+
+### Developer Experience
+
+- Version synchronization scripts
+- Manual release workflow enhancements
+- Automatic release notes generation
+- Changelog file path configuration
+
+[View v4.43.1 tag](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4.43.1)
+
+## [v4.30.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v4.30.0)
+
+**Release: July 2025 (v4.21.0 - v4.30.4)**
+
+Introduction of advanced IDE integrations and command systems.
+
+### Claude Code Integration
+
+- **Slash Commands**: Native Claude Code slash command support for agents
+- **Task Commands**: Direct task invocation via slash commands
+- **BMad Subdirectory**: Organized command structure
+- **Nested Organization**: Clean command hierarchy
+
+### Agent Enhancements
+
+- BMad-master knowledge base loading
+- Improved brainstorming facilitation
+- Better agent task following with cost-saving model combinations
+- Direct commands in agent definitions
+
+### Installer Improvements
+
+- Memory-efficient processing
+- Clear multi-select IDE prompts
+- GitHub Copilot support with improved UX
+- ASCII logo (because why not)
+
+### Platform Support
+
+- Windows compatibility improvements (regex fixes, newline handling)
+- Roo modes configuration
+- Support for multiple CLI tools simultaneously
+
+### Expansion Ecosystem
+
+- 2D Unity Game Development expansion pack
+- Improved expansion pack documentation
+- Better isolated expansion pack installations
+
+[View v4.30.4 tag](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4.30.4)
+
+## [v4.20.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v4.20.0)
+
+**Release: June 2025 (v4.11.0 - v4.20.0)**
+
+Major focus on documentation quality and expanding QA agent capabilities.
+
+### Documentation Overhaul
+
+- **Workflow Diagrams**: Visual explanations of planning and development cycles
+- **QA Role Expansion**: QA agent transformed into senior code reviewer
+- **User Guide Refresh**: Complete rewrite with clearer explanations
+- **Contributing Guidelines**: Clarified principles and contribution process
+
+### QA Agent Transformation
+
+- Elevated from simple tester to senior developer/code reviewer
+- Code quality analysis and architectural feedback
+- Pre-implementation review capabilities
+- Integration with dev cycle for quality gates
+
+### IDE Ecosystem Growth
+
+- **Cline IDE Support**: Added configuration for Cline
+- **Gemini CLI Integration**: Native Gemini CLI support
+- **Expansion Pack Installation**: Automated expansion agent setup across IDEs
+
+### New Capabilities
+
+- Markdown-tree integration for document sharding
+- Quality gates to prevent task completion with failures
+- Enhanced brownfield workflow documentation
+- Team-based agent bundling improvements
+
+### Developer Tools
+
+- Better expansion pack isolation
+- Automatic rule generation for all supported IDEs
+- Common files moved to shared locations
+- Hardcoded dependencies removed from installer
+
+[View v4.20.0 tag](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4.20.0)
+
+## [v4.10.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v4.10.0)
+
+**Release: June 2025 (v4.3.0 - v4.10.3)**
+
+This release focused on making BMAD more configurable and adaptable to different project structures.
+
+### Configuration System
+
+- **Optional Core Config**: Document sharding and core configuration made optional
+- **Flexible File Resolution**: Support for non-standard document structures
+- **Debug Logging**: Configurable debug mode for agent troubleshooting
+- **Fast Update Mode**: Quick updates without breaking customizations
+
+### Agent Improvements
+
+- Clearer file resolution instructions for all agents
+- Fuzzy task resolution for better agent autonomy
+- Web orchestrator knowledge base expansion
+- Better handling of deviant PRD/Architecture structures
+
+### Installation Enhancements
+
+- V4 early detection for improved update flow
+- Prevented double installation during updates
+- Better handling of YAML manifest files
+- Expansion pack dependencies properly included
+
+### Bug Fixes
+
+- SM agent file resolution issues
+- Installer upgrade path corrections
+- Bundle build improvements
+- Template formatting fixes
+
+[View v4.10.3 tag](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4.10.3)
+
+## [v4.0.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v4.0.0)
+
+**Release: June 20, 2025 (v4.0.0 - v4.2.0)**
+
+Version 4 represented a complete architectural overhaul, transforming BMAD from a collection of prompts into a professional, distributable framework.
+
+### Framework Transformation
+
+- **NPM Package**: Professional distribution and simple installation via `npx bmad-method install`
+- **Modular Architecture**: Move to `.bmad-core` hidden folder structure
+- **Multi-IDE Support**: Unified support for Claude Code, Cursor, Roo, Windsurf, and many more
+- **Schema Standardization**: YAML-based agent and team definitions
+- **Automated Installation**: One-command setup with upgrade detection
+
+### Agent System Overhaul
+
+- Agent team workflows (fullstack, no-ui, all agents)
+- Web bundle generation for platform-agnostic deployment
+- Task-based architecture (separate task definitions from agents)
+- IDE-specific agent activation (slash commands for Claude Code, rules for Cursor, etc.)
+
+### New Capabilities
+
+- Brownfield project support (existing codebases)
+- Greenfield project workflows (new projects)
+- Expansion pack architecture for domain specialization
+- Document sharding for better context management
+- Automatic semantic versioning and releases
+
+### Developer Experience
+
+- Automatic upgrade path from v3 to v4
+- Backup creation for user customizations
+- VSCode settings and markdown linting
+- Comprehensive documentation restructure
+
+[View v4.2.0 tag](https://github.com/bmad-code-org/BMAD-METHOD/tree/v4.2.0)
+
+## [v3.0.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v3.0.0)
+
+**Release: May 20, 2025**
+
+Version 3 introduced the revolutionary orchestrator concept, creating a unified agent experience.
+
+### Major Features
+
+- **BMad Orchestrator**: Uber-agent that orchestrates all specialized agents
+- **Web-First Approach**: Streamlined web setup with pre-compiled agent bundles
+- **Simplified Onboarding**: Complete setup in minutes with clear quick-start guide
+- **Build System**: Scripts to compile web agents from modular components
+
+### Architecture Changes
+
+- Consolidated agent system with centralized orchestration
+- Web build sample folder with ready-to-deploy configurations
+- Improved documentation structure with visual setup guides
+- Better separation between web and IDE workflows
+
+### New Capabilities
+
+- Single agent interface (`/help` command system)
+- Brainstorming and ideation support
+- Integrated method explanation within the agent itself
+- Cross-platform consistency (Gemini Gems, Custom GPTs)
+
+[View V3 Branch](https://github.com/bmad-code-org/BMAD-METHOD/tree/V3)
+
+## [v2.0.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v2.0.0)
+
+**Release: April 17, 2025**
+
+Version 2 addressed the major shortcomings of V1 by introducing separation of concerns and quality validation mechanisms.
+
+### Major Improvements
+
+- **Template Separation**: Templates decoupled from agent definitions for greater flexibility
+- **Quality Checklists**: Advanced elicitation checklists to validate document quality
+- **Web Agent Discovery**: Recognition of Gemini Gems and Custom GPTs power for structured planning
+- **Granular Web Agents**: Simplified, clearly-defined agent roles optimized for web platforms
+- **Installer**: A project installer that copied the correct files to a folder at the destination
+
+### Key Features
+
+- Separated template files from agent personas
+- Introduced forced validation rounds through checklists
+- Cost-effective structured planning workflow using web platforms
+- Self-contained agent personas with external template references
+
+### Known Issues
+
+- Duplicate templates/checklists for web vs IDE versions
+- Manual export/import workflow between agents
+- Creating each web agent separately was tedious
+
+[View V2 Branch](https://github.com/bmad-code-org/BMAD-METHOD/tree/V2)
+
+## [v1.0.0](https://github.com/bmad-code-org/BMAD-METHOD/releases/tag/v1.0.0)
+
+**Initial Release: April 6, 2025**
+
+The original BMAD Method was a tech demo showcasing how different custom agile personas could be used to build out artifacts for planning and executing complex applications from scratch. This initial version established the foundation of the AI-driven agile development approach.
+
+### Key Features
+
+- Introduction of specialized AI agent personas (PM, Architect, Developer, etc.)
+- Template-based document generation for planning artifacts
+- Emphasis on planning MVP scope with sufficient detail to guide developer agents
+- Hard-coded custom mode prompts integrated directly into agent configurations
+- The OG of Context Engineering in a structured way
+
+### Limitations
+
+- Limited customization options
+- Web usage was complicated and not well-documented
+- Rigid scope and purpose with templates coupled to agents
+- Not optimized for IDE integration
+
+[View V1 Branch](https://github.com/bmad-code-org/BMAD-METHOD/tree/V1)
+
+## Installation
+
+```bash
+npx bmad-method
+```
+
+For detailed release notes, see the [GitHub releases page](https://github.com/bmad-code-org/BMAD-METHOD/releases).

CONTRIBUTING.md

@@ -0,0 +1,279 @@
+# Contributing to BMad
+
+Thank you for considering contributing to the BMad project! We believe in **Human Amplification, Not Replacement** - bringing out the best thinking in both humans and AI through guided collaboration.
+
+💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
+
+- **#general-dev** - Technical discussions, feature ideas, and development questions
+- **#bugs-issues** - Bug reports and issue discussions
+
+## Our Philosophy
+
+### BMad Core™: Universal Foundation
+
+BMad Core empowers humans and AI agents working together in true partnership across any domain through our **C.O.R.E. Framework** (Collaboration Optimized Reflection Engine):
+
+- **Collaboration**: Human-AI partnership where both contribute unique strengths
+- **Optimized**: The collaborative process refined for maximum effectiveness
+- **Reflection**: Guided thinking that helps discover better solutions and insights
+- **Engine**: The powerful framework that orchestrates specialized agents and workflows
+
+### BMad Method™: Agile AI-Driven Development
+
+The BMad Method is the flagship bmad module for agile AI-driven software development. It emphasizes thorough planning and solid architectural foundations to provide detailed context for developer agents, mirroring real-world agile best practices.
+
+### Core Principles
+
+**Partnership Over Automation** - AI agents act as expert coaches, mentors, and collaborators who amplify human capability rather than replace it.
+
+**Bidirectional Guidance** - Agents guide users through structured workflows while users push agents with advanced prompting. Both sides actively work to extract better information from each other.
+
+**Systems of Workflows** - BMad Core builds comprehensive systems of guided workflows with specialized agent teams for any domain.
+
+**Tool-Agnostic Foundation** - BMad Core remains tool-agnostic, providing stable, extensible groundwork that adapts to any domain.
+
+## What Makes a Good Contribution?
+
+Every contribution should strengthen human-AI collaboration. Ask yourself: **"Does this make humans and AI better together?"**
+
+**✅ Contributions that align:**
+
+- Enhance universal collaboration patterns
+- Improve agent personas and workflows
+- Strengthen planning and context continuity
+- Increase cross-domain accessibility
+- Add domain-specific modules leveraging BMad Core
+
+**❌ What detracts from our mission:**
+
+- Purely automated solutions that sideline humans
+- Tools that don't improve the partnership
+- Complexity that creates barriers to adoption
+- Features that fragment BMad Core's foundation
+
+## Before You Contribute
+
+### Reporting Bugs
+
+1. **Check existing issues** first to avoid duplicates
+2. **Consider discussing in Discord** (#bugs-issues channel) for quick help
+3. **Use the bug report template** when creating a new issue - it guides you through providing:
+   - Clear bug description
+   - Steps to reproduce
+   - Expected vs actual behavior
+   - Model/IDE/BMad version details
+   - Screenshots or links if applicable
+4. **Indicate if you're working on a fix** to avoid duplicate efforts
+
+### Suggesting Features or New Modules
+
+1. **Discuss first in Discord** (#general-dev channel) - the feature request template asks if you've done this
+2. **Check existing issues and discussions** to avoid duplicates
+3. **Use the feature request template** when creating an issue
+4. **Be specific** about why this feature would benefit the BMad community and strengthen human-AI collaboration
+
+### Before Starting Work
+
+⚠️ **Required before submitting PRs:**
+
+1. **For bugs**: Check if an issue exists (create one using the bug template if not)
+2. **For features**: Discuss in Discord (#general-dev) AND create a feature request issue
+3. **For large changes**: Always open an issue first to discuss alignment
+
+Please propose small, granular changes! For large or significant changes, discuss in Discord and open an issue first. This prevents wasted effort on PRs that may not align with planned changes.
+
+## Pull Request Guidelines
+
+### Which Branch?
+
+**Submit to `next` branch** (most contributions):
+
+- ✨ New features or agents
+- 🎨 Enhancements to existing features
+- 📚 Documentation updates
+- ♻️ Code refactoring
+- ⚡ Performance improvements
+- 🧪 New tests
+- 🎁 New bmad modules
+
+**Submit to `main` branch** (critical only):
+
+- 🚨 Critical bug fixes that break basic functionality
+- 🔒 Security patches
+- 📚 Fixing dangerously incorrect documentation
+- 🐛 Bugs preventing installation or basic usage
+
+**When in doubt, submit to `next`**. We'd rather test changes thoroughly before they hit stable.
+
+### PR Size Guidelines
+
+- **Ideal PR size**: 200-400 lines of code changes
+- **Maximum PR size**: 800 lines (excluding generated files)
+- **One feature/fix per PR**: Each PR should address a single issue or add one feature
+- **If your change is larger**: Break it into multiple smaller PRs that can be reviewed independently
+- **Related changes**: Even related changes should be separate PRs if they deliver independent value
+
+### Breaking Down Large PRs
+
+If your change exceeds 800 lines, use this checklist to split it:
+
+- [ ] Can I separate the refactoring from the feature implementation?
+- [ ] Can I introduce the new API/interface in one PR and implementation in another?
+- [ ] Can I split by file or module?
+- [ ] Can I create a base PR with shared utilities first?
+- [ ] Can I separate test additions from implementation?
+- [ ] Even if changes are related, can they deliver value independently?
+- [ ] Can these changes be merged in any order without breaking things?
+
+Example breakdown:
+
+1. PR #1: Add utility functions and types (100 lines)
+2. PR #2: Refactor existing code to use utilities (200 lines)
+3. PR #3: Implement new feature using refactored code (300 lines)
+4. PR #4: Add comprehensive tests (200 lines)
+
+**Note**: PRs #1 and #4 could be submitted simultaneously since they deliver independent value.
+
+### Pull Request Process
+
+#### New to Pull Requests?
+
+If you're new to GitHub or pull requests, here's a quick guide:
+
+1. **Fork the repository** - Click the "Fork" button on GitHub to create your own copy
+2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
+3. **Create a new branch** - Never work on `main` directly!
+   ```bash
+   git checkout -b fix/description
+   # or
+   git checkout -b feature/description
+   ```
+4. **Make your changes** - Edit files, keeping changes small and focused
+5. **Commit your changes** - Use clear, descriptive commit messages
+   ```bash
+   git add .
+   git commit -m "fix: correct typo in README"
+   ```
+6. **Push to your fork** - `git push origin fix/description`
+7. **Create the Pull Request** - Go to your fork on GitHub and click "Compare & pull request"
+
+### PR Description Template
+
+Keep your PR description concise and focused. Use this template:
+
+```markdown
+## What
+
+[1-2 sentences describing WHAT changed]
+
+## Why
+
+[1-2 sentences explaining WHY this change is needed]
+Fixes #[issue number] (if applicable)
+
+## How
+
+## [2-3 bullets listing HOW you implemented it]
+
+-
+-
+
+## Testing
+
+[1-2 sentences on how you tested this]
+```
+
+**Maximum PR description length: 200 words** (excluding code examples if needed)
+
+### Good vs Bad PR Descriptions
+
+❌ **Bad Example:**
+
+> This revolutionary PR introduces a paradigm-shifting enhancement to the system's architecture by implementing a state-of-the-art solution that leverages cutting-edge methodologies to optimize performance metrics...
+
+✅ **Good Example:**
+
+> **What:** Added validation for agent dependency resolution
+> **Why:** Build was failing silently when agents had circular dependencies
+> **How:**
+>
+> - Added cycle detection in dependency-resolver.js
+> - Throws clear error with dependency chain
+>   **Testing:** Tested with circular deps between 3 agents
+
+### Commit Message Convention
+
+Use conventional commits format:
+
+- `feat:` New feature
+- `fix:` Bug fix
+- `docs:` Documentation only
+- `refactor:` Code change that neither fixes a bug nor adds a feature
+- `test:` Adding missing tests
+- `chore:` Changes to build process or auxiliary tools
+
+Keep commit messages under 72 characters.
+
+### Atomic Commits
+
+Each commit should represent one logical change:
+
+- **Do:** One bug fix per commit
+- **Do:** One feature addition per commit
+- **Don't:** Mix refactoring with bug fixes
+- **Don't:** Combine unrelated changes
+
+## What Makes a Good Pull Request?
+
+✅ **Good PRs:**
+
+- Change one thing at a time
+- Have clear, descriptive titles
+- Explain what and why in the description
+- Include only the files that need to change
+- Reference related issue numbers
+
+❌ **Avoid:**
+
+- Changing formatting of entire files
+- Multiple unrelated changes in one PR
+- Copying your entire project/repo into the PR
+- Changes without explanation
+- Working directly on `main` branch
+
+## Common Mistakes to Avoid
+
+1. **Don't reformat entire files** - only change what's necessary
+2. **Don't include unrelated changes** - stick to one fix/feature per PR
+3. **Don't paste code in issues** - create a proper PR instead
+4. **Don't submit your whole project** - contribute specific improvements
+
+## Code Style
+
+- Follow the existing code style and conventions
+- Write clear comments for complex logic
+- Keep dev agents lean - they need context for coding, not documentation
+- Web/planning agents can be larger with more complex tasks
+- Everything is natural language (markdown) - no code in core framework
+- Use bmad modules for domain-specific features
+
+## Code of Conduct
+
+By participating in this project, you agree to abide by our Code of Conduct. We foster a collaborative, respectful environment focused on building better human-AI partnerships.
+
+## Need Help?
+
+- 💬 Join our [Discord Community](https://discord.gg/gk8jAdXWmj):
+  - **#general-dev** - Technical questions and feature discussions
+  - **#bugs-issues** - Get help with bugs before filing issues
+- 🐛 Report bugs using the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
+- 💡 Suggest features using the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
+- 📖 Browse the [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
+
+---
+
+**Remember**: We're here to help! Don't be afraid to ask questions. Every expert was once a beginner. Together, we're building a future where humans and AI work better together.
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

LICENSE

@@ -0,0 +1,26 @@
+MIT License
+
+Copyright (c) 2025 BMad Code, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+TRADEMARK NOTICE:
+BMAD™, BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these 
+trademarks in this software does not grant any rights to use the trademarks 
+for any other purpose.

README.md

@@ -1,13 +1,285 @@
-# BMad Method V2
+# BMad CORE v6 Alpha
 
-V2 was the major fix to the shortcomings of V1.
+[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
+[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
 
-Templates were introduced, and separated from the agents themselves. Also aside from templates, checklists were introduced to give more power in actually vetting the the documents or artifacts being produced were valid and of high quality through a forced round of advanced elicitation.
+## 🚀 Critical: Understanding BMad Method v6a Workflow
 
-During V2, this is where the discovery of the power of Gemini Gems and Custom GPTs came to light, really indicating how powerful and cost effective it can be to utilize the Web for a lot of the initial planning, but doing it in a structured repeatable way!
+**IMPORTANT: Before using this framework, you MUST read the [BMM v6 Workflows Guide](./src/modules/bmm/workflows/README.md).** This document is fundamental to understanding how to use v6 of the BMad Method and explains the revolutionary v6a workflow system with its four phases: Analysis, Planning, Solutioning, and Implementation.
 
-The Web Agents were all granular and clearly defined - a much simpler system, but also somewhat of a pain to create each agent separately in the web while also having to manually export and reimport each document when going agent to agent.
+**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)** and **[Join our amazing, active Discord Community](https://discord.gg/gk8jAdXWmj)**
 
-Also one confusing aspect was that there were duplicates of temples and checklists for the web versions and the ide versions.
+⭐ **If you find this project helpful or useful, please give it a star in the upper right-hand corner!** It helps others discover BMad-CORE and you will be notified of updates!
 
-But - overall, this was a very low bar to entry to pick up and start using it - The agent personas were all still pretty self contained, aside from calling out to separate template files for the documents.
+## The Universal Human-AI Collaboration Platform
+
+📋 **[View v6 Alpha Open Items & Roadmap](./v6-open-items.md)** - Track what's being worked on and what's coming next!
+
+### ⚠️ Important Alpha Notes
+
+**Note 0 - Frequent Updates:** Updates to the branch will be frequent. When pulling new updates, it's best to delete your node_modules folder and run `npm install` to ensure you have the latest package dependencies.
+
+**Note 1 - Alpha Stability:** ALPHA is potentially an unstable release that could drastically change. While we hope that isn't the case, your testing during this time is much appreciated. Please help us out by filing issues or reaching out in Discord to discuss.
+
+**Note 2 - Work in Progress:** ALPHA is not complete - there are still many small and big features, polish, doc improvements, and more agents and workflows coming ahead of the beta release!
+
+**Note 3 - IDE Required:** ALPHA Web Bundles and Agents are not fully working yet - you will need to use a good quality IDE to test many features, especially with the BMad Method module. However, the new agent builder and standalone agent feature can work great with weaker models - this will still evolve over the coming weeks.
+
+**Note 4 - Contributing:** If you would like to contribute a PR, make sure you are creating your PR against the Alpha Branch and not Main.
+
+## Alpha Installation and Testing
+
+**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
+
+### Option A
+
+Thank you Lum for the suggestion - here is a one-shot instruction to clone just the alpha branch and get started:
+
+`git clone --branch v6-alpha --single-branch https://github.com/bmad-code-org/BMAD-METHOD` and then cd into this directory and run `npm install`.
+
+### Option B
+
+Here are the more detailed step-by-step instructions:
+
+Clone the repo with either:
+
+- `gh repo clone bmad-code-org/BMAD-METHOD`
+- `git clone https://github.com/bmad-code-org/BMAD-METHOD.git`
+- `git@github.com:bmad-code-org/BMAD-METHOD.git`
+  and then cd into the BMAD-METHOD folder.
+
+  You will then need to change to the branch as that will have cloned main, so type:
+  - `git checkout v6-alpha`
+  - type `git status` and you should see:
+    `On branch v6-alpha. Your branch is up to date with 'origin/v6-alpha'.`
+
+### Node Modules install
+
+Now you must install the node_modules with `npm install` - once complete, you should see you have a `node_modules` folder at the root of your project. (BMAD-METHOD/node_modules)
+
+### Install to your new or existing project folder
+
+Now you can run `npm run install:bmad` and follow the installer questions.
+
+NOTE: One of the first questions will ask for a destination - do not accept the default, you want to enter the full path to a new or existing folder of where your project is or will be. If you choose a net new folder, you will have to confirm you want the installer to create the directory for you.
+
+The Core Module will always be installed. The default initial module selection will be BMM for all the core BMad Method functionality and flow from brainstorming through software development.
+
+**Note on installation:** All installs now go to a single folder called `bmad` instead of multiple folders. When you install a module, you may still see folders other than the one you selected in the destination/bmad folder.
+
+This is intentional and not a bug - it will copy over to those other folders only the minimum that is needed because it is shared across the modules. For example, during Alpha to test this feature, BMM relies on the brainstorming feature of the CIS and some items from CORE - so even if you only select BMM, you will still see bmad/core and bmad/cis along with bmad/bmm.
+
+## What is the new BMad Core
+
+BMad-CORE (Collaboration Optimized Reflection Engine) is a framework that brings out the best in you through AI agents designed to enhance human thinking rather than replace it.
+
+Unlike traditional AI tools that do the work for you, BMad-CORE's specialized agents guide you through the facilitation of optimized collaborative reflective workflows to unlock your full potential across any domain. This magic powers the BMad Method, which is just one of the many modules that exist or are coming soon.
+
+## What Makes BMad-Core Different
+
+**Traditional AI**: Does the thinking for you, providing average, bland answers and solutions
+**BMad-CORE**: Brings out the best thinking in you and the AI through guided collaboration, elicitation, and facilitation
+
+### Core Philosophy: Human Amplification, Not Replacement
+
+BMad-Core's AI agents act as expert coaches, mentors, and collaborators who:
+
+- Ask the right questions to stimulate your thinking
+- Provide structured frameworks for complex problems
+- Guide you through reflective processes to discover insights
+- Help you develop mastery in your chosen domains
+- Amplify your natural abilities rather than substituting for them
+
+## The Collaboration Optimized Reflection Engine
+
+At the heart of BMad-Core lies the **C.O.R.E.** system:
+
+- **Collaboration**: Human-AI partnership where both contribute unique strengths
+- **Optimized**: The collaborative process has been refined for maximum effectiveness
+- **Reflection**: Guided thinking that helps you discover better solutions and insights
+- **Engine**: The powerful framework that orchestrates specialized agents and workflows
+
+## Universal Domain Coverage Through Modules
+
+BMad-CORE works in ANY domain through specialized modules (previously called expansion packs)!
+
+### Available Modules with Alpha Release
+
+- **BMad Core (core)**: Included and used to power every current and future module; includes a master orchestrator for the local environment and one for the web bundles used with ChatGPT or Gemini Gems, for example.
+
+- **[BMad Method (bmm)](./src/modules/bmm/README.md)**: Agile AI-driven software development - the classic that started it all and is still the best - but with v6, massively improved thanks to a rebuild from the ground up built on the new powerful BMad-CORE engine. The BMad Method has also been expanded to use a new "Scale Adaptive Workflow Engine"™. **[See BMM Documentation](./src/modules/bmm/README.md)**
+
+- **[BMad BoMB (bmb)](./src/modules/bmb/README.md)**: The BMad Builder is your Custom Agent, Workflow, and Module authoring tool - it's now easier than ever to customize existing modules or create whatever you can imagine as a standalone module. **[See BMB Documentation](./src/modules/bmb/README.md)**
+
+- **Creative Intelligence Suite (cis)**: Unlock innovation, problem-solving, and creative thinking! Brainstorming that was part of the BMad Method in the past is now part of this standalone module along with other workflows. The power of BMad modules still allows modules to borrow from each other - so the CIS, while standalone, also powers the brainstorming abilities for certain agents within the BMad Method!
+
+## What's New in V6-ALPHA
+
+Stability, customizability, installation Q&A, massive prompt improvements.
+
+Everything has been rewritten from the ground up with best practices and advances learned over previous versions, standardizing on prompt format techniques. There is much more core usage of XML or XML-type tags within markdown, with many conventions and standards that drastically increase agent adherence.
+
+**Customizability** is a key theme of this new version. All agents are now customizable by modifying a file under the installation bmad/\_cfg/agents. Every agent installed will generate an agent file that you can customize.
+
+The nice thing about this is when agents change or update in future versions, your customizations in these sidecar files will never be lost! You can change the name, their personas, how they talk, what they call you, and most exciting - what language they communicate in!
+
+The **BMad installer** is 100% new from the ground up. Along the way you will add:
+
+- Your name (what the agents will call you and how you'll author documents)
+- What language you want the agents to communicate in
+- Module-specific customization options
+
+When you install, a consolidated agent party is created so now when you use party-mode in the IDE, it is super efficient for the agent running the party to simulate all installed agents. Post alpha release, this will manifest itself in many interesting ways in time for beta - but for now, have fun with party mode and epic sprint retrospectives!
+
+Speaking of installation - everything will now install to a single core bmad folder. No more separate root folders for every module! Instead, all will be contained within bmad/.
+
+All IDE selections now support the option to add special install functionality per module.
+
+For example, with the alpha release, if you select the BMad Method and Claude Code, you will have an option to install pre-created Claude sub-agents. Not only do they get installed, but certain workflows will have injected into their instructions key indicators to the agent when to activate the sub-agents, removing some non-determinism.
+
+The sub-agent experience is still undergoing some work, so install them if you choose, and remove them if they become a pain.
+
+When you read about the BoMB below, it will link to more information about various features in this new evolution of BMad Code. One of the exciting features is the new agent types - there are 3 now! The most exciting are the new standalone tiny agents that you can easily generate and deploy free from any module - specialized for your exact needs.
+
+### BMad Method (BMM)
+
+📚 **[Full BMM Documentation](./src/modules/bmm/README.md)** | **[v6 Workflows Guide](./src/modules/bmm/workflows/README.md)**
+
+The BMad Method is significantly transforming and yet more powerful than ever. **Scale Adaptive** is a new term that means when you start the workflow to create a PRD or a GDD (or a simple tech-spec in the case of simple tasks), you will first answer some questions about the scope of the project, new vs. existing codebase and its state, and other questions. This will trigger a leveling of the effort from 0-4, and based on this scale adaptation, it will guide the workflow in different directions.
+
+Right now, this is still a bit alpha feeling and disjointed, but before beta it will be tied together through all four workflow phases with a potential single orchestration if you choose - or you can still jump right in, especially for simple tasks that just need a simple tech-spec and then right off to development.
+
+To test and experience this now, here is the new main flow for BMM v6 alpha:
+
+(Docs will be all linked in soon with new user guide and workflow diagrams coming this week)
+
+**NOTE:** Game Development expansion packs are all being rolled into the official BMad Method module - along with any more game engine platforms being added. Additionally, game development planning for the GDD is not only scale adaptive, but also adapts to the type of game you are making - so you can plan all that is needed for your dream game!
+
+#### **PHASE 1 - Analysis**
+
+**Analyst:**
+
+- `brainstorm-project`
+- `research` (market research, deep research, deep research prompt generation)
+- `product-brief`
+
+**Game Designer (Optional):**
+
+- `brainstorm-game`
+- `game-brief`
+- `research`
+
+---
+
+#### **PHASE 2 - Planning**
+
+**PM:**
+
+- `plan-project`
+
+**Game Designer:**
+
+- `plan-game` (calls the same plan-project workflow, but input docs or your answers should drive it towards GDD)
+
+---
+
+#### **PHASE 3 - Solutioning**
+
+**Architect or Game Architect:**
+
+Just like the scale-adjusted planning, architecture is the same. No more document sharding though!
+
+Now in the IDE you create an architecture that adapts to the type of project you are working on - based on the inputs from your PRD, it will adapt the sections it includes to your project type. No longer is the architecture biased just towards full stack or back-end APIs. There are many more options now, from embedded hardware to mobile to many other options - with many more coming with beta.
+
+- `solution-architecture`
+
+> **Note:** Testing, DevOps, or security concerns beyond the basics are generally not included in the architecture. If it is more complicated, especially for complex massive undertakings, you will be suggested to pull in specific agents to help with those areas. _(Not released with alpha.0, coming soon)_
+
+Once the full architecture is complete, you can still use the PO to run the checklist to validate the epics and stories are still correct - although the architect should also be keeping them updated as needed (needs some tuning during alpha). Once done, then it's time to create the tech spec for your first epic.
+
+- `tech-spec`
+
+The tech spec pulls all technical information from all planning thus far, along with any further research needed from the web to produce an **Epic Tech Spec** - each epic will have one. This is going to make the SM even more capable of finding the info it needs for each story when we get to phase 4!
+
+---
+
+#### **PHASE 4 - Implementation**
+
+And now here we are at phase 4 - where we, just like in BMad Method of yore, use the SM and the Dev Agent. No more QA agent here though; the dev now has a dev task and also a senior dev agent review task.
+
+**Scrum Master (SM) Tasks:**
+
+Before the dev starts, the SM will:
+
+1. `create-story`
+2. `story-context` _(NEW!)_
+
+**Story-context** is a game-changing new feature beyond what we had with create-story in the past. Create-story still pulls in all the info it needs from the tech-spec and elsewhere as needed (including previously completed stories), but the generation of the new story-context takes it to a whole new level.
+
+This real-time prep means no more generic devLoadAlways list of story files. During the alpha phase, we will be tuning what goes into this context, but this is going to supercharge and specialize your dev to the story at hand!
+
+---
+
+> **🎉 There are many other exciting changes throughout for you to discover during the alpha BMad Method module!**
+
+## CIS
+
+The CIS has 5 agents to try out, each with their own workflow! This is a new module that will drastically change over time.
+
+- [CIS Readme](./src/modules/cis/readme.md)
+
+### BoMB: BMad Builder (BMB)
+
+📚 **[Full BMB Documentation](./src/modules/bmb/README.md)** | **[Agent Creation Guide](./src/modules/bmb/workflows/create-agent/README.md)**
+
+#### Agent Docs
+
+- [Agent Architecture](src/modules/bmb/workflows/create-agent/agent-architecture)
+- [Agent command patterns](src/modules/bmb/workflows/create-agent/agent-command-patterns.md)
+- [Agent Types](src/modules/bmb/workflows/create-agent/agent-types.md)
+- [Communication Styles](src/modules/bmb/workflows/create-agent/communication-styles.md)
+
+#### Modules
+
+Modules are what we used to call Expansion Packs. A new repository to contribute modules is coming very soon with the beta release where you can start contributing modules - we just want to make sure the final format and conventions are stable. A module will generally be made up of agents and workflows. Tasks are still also possible, but generally should be avoided in favor of more flexible workflows. Workflows can have sub-workflows and soon will support a standardized multi-workflow orchestration pattern that the BMad master will be able to guide users through.
+
+- [Module Structure](src/modules/bmb/workflows/create-module/module-structure.md)
+
+#### Workflows
+
+What used to be tasks and create-doc templates are now all workflows! Simpler, yet more powerful and support many ways of achieving many different outcomes! A lot more documentation will be coming. This document is used by the agent builder to generate workflows or convert to workflows, but there is a lot more than what we have documented here in this alpha doc.
+
+- [Workflow Creation Guide](src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md)
+
+### Installer Changes
+
+- [IDE Injections](docs/installers-bundlers/ide-injections)
+- [Installers Modules Platforms References](docs/installers-bundlers/installers-modules-platforms-reference)
+- [Web Bundler Usage](docs/installers-bundlers/web-bundler-usage)
+- [Claude Code Sub Module BMM Installer](src/modules/bmm/sub-modules/claude-code/readme.md)
+
+## Support & Community
+
+- 💬 [Discord Community](https://discord.gg/gk8jAdXWmj) - Get help, share ideas, collaborate
+- 🐛 [Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues) - Bug reports and feature requests
+- 💬 [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) - Community conversations
+
+## Contributing
+
+We welcome contributions and new module development!
+
+📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete contribution guide
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Trademark Notice
+
+BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
+
+[![Contributors](https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD)](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
+
+<sub>Built with ❤️ for the human-AI collaboration community</sub>

V2-FULL-DEMO-WALKTHROUGH/_index.md

@@ -1,48 +0,0 @@
-# Documentation Index
-
-## Overview
-
-This index catalogs all documentation files for the BMAD-METHOD project, organized by category for easy reference and AI discoverability.
-
-## Product Documentation
-
-- **[prd.md](prd.md)** - Product Requirements Document outlining the core project scope, features and business objectives.
-- **[final-brief-with-pm-prompt.md](final-brief-with-pm-prompt.md)** - Finalized project brief with Product Management specifications.
-- **[demo.md](demo.md)** - Main demonstration guide for the BMAD-METHOD project.
-
-## Architecture & Technical Design
-
-- **[architecture.md](architecture.md)** - System architecture documentation detailing technical components and their interactions.
-- **[tech-stack.md](tech-stack.md)** - Overview of the technology stack used in the project.
-- **[project-structure.md](project-structure.md)** - Explanation of the project's file and folder organization.
-- **[data-models.md](data-models.md)** - Documentation of data models and database schema.
-- **[environment-vars.md](environment-vars.md)** - Required environment variables and configuration settings.
-
-## API Documentation
-
-- **[api-reference.md](api-reference.md)** - Comprehensive API endpoints and usage reference.
-
-## Epics & User Stories
-
-- **[epic1.md](epic1.md)** - Epic 1 definition and scope.
-- **[epic2.md](epic2.md)** - Epic 2 definition and scope.
-- **[epic3.md](epic3.md)** - Epic 3 definition and scope.
-- **[epic4.md](epic4.md)** - Epic 4 definition and scope.
-- **[epic5.md](epic5.md)** - Epic 5 definition and scope.
-- **[epic-1-stories-demo.md](epic-1-stories-demo.md)** - Detailed user stories for Epic 1.
-- **[epic-2-stories-demo.md](epic-2-stories-demo.md)** - Detailed user stories for Epic 2.
-- **[epic-3-stories-demo.md](epic-3-stories-demo.md)** - Detailed user stories for Epic 3.
-
-## Development Standards
-
-- **[coding-standards.md](coding-standards.md)** - Coding conventions and standards for the project.
-- **[testing-strategy.md](testing-strategy.md)** - Approach to testing, including methodologies and tools.
-
-## AI & Prompts
-
-- **[prompts.md](prompts.md)** - AI prompt templates and guidelines for project assistants.
-- **[combined-artifacts-for-posm.md](combined-artifacts-for-posm.md)** - Consolidated project artifacts for Product Owner and Solution Manager.
-
-## Reference Documents
-
-- **[botched-architecture-draft.md](botched-architecture-draft.md)** - Archived architecture draft (for reference only).

V2-FULL-DEMO-WALKTHROUGH/api-reference.md

@@ -1,97 +0,0 @@
-# BMad Hacker Daily Digest API Reference
-
-This document describes the external APIs consumed by the BMad Hacker Daily Digest application.
-
-## External APIs Consumed
-
-### Algolia Hacker News (HN) Search API
-
-- **Purpose:** Used to fetch the top Hacker News stories and the comments associated with each story.
-- **Base URL:** `http://hn.algolia.com/api/v1`
-- **Authentication:** None required for public search endpoints.
-- **Key Endpoints Used:**
-
-  - **`GET /search` (for Top Stories)**
-
-    - Description: Retrieves stories based on search parameters. Used here to get top stories from the front page.
-    - Request Parameters:
-      - `tags=front_page`: Required to filter for front-page stories.
-      - `hitsPerPage=10`: Specifies the number of stories to retrieve (adjust as needed, default is typically 20).
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const url =
-        "[http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10](http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10)";
-      const response = await fetch(url);
-      const data = await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See "Algolia HN API - Story Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing story objects.
-    - Error Response Schema(s): Standard HTTP errors (e.g., 4xx, 5xx). May return JSON with an error message.
-
-  - **`GET /search` (for Comments)**
-    - Description: Retrieves comments associated with a specific story ID.
-    - Request Parameters:
-      - `tags=comment,story_{storyId}`: Required to filter for comments belonging to the specified `storyId`. Replace `{storyId}` with the actual ID (e.g., `story_12345`).
-      - `hitsPerPage={maxComments}`: Specifies the maximum number of comments to retrieve (value from `.env` `MAX_COMMENTS_PER_STORY`).
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const storyId = "..."; // HN Story ID
-      const maxComments = 50; // From config
-      const url = `http://hn.algolia.com/api/v1/search?tags=comment,story_${storyId}&hitsPerPage=${maxComments}`;
-      const response = await fetch(url);
-      const data = await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See "Algolia HN API - Comment Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing comment objects.
-    - Error Response Schema(s): Standard HTTP errors.
-
-- **Rate Limits:** Subject to Algolia's public API rate limits (typically generous for HN search but not explicitly defined/guaranteed). Implementations should handle potential 429 errors gracefully if encountered.
-- **Link to Official Docs:** [https://hn.algolia.com/api](https://hn.algolia.com/api)
-
-### Ollama API (Local Instance)
-
-- **Purpose:** Used to generate text summaries for scraped article content and HN comment discussions using a locally running LLM.
-- **Base URL:** Configurable via the `OLLAMA_ENDPOINT_URL` environment variable (e.g., `http://localhost:11434`).
-- **Authentication:** None typically required for default local installations.
-- **Key Endpoints Used:**
-
-  - **`POST /api/generate`**
-    - Description: Generates text based on a model and prompt. Used here for summarization.
-    - Request Body Schema: See `OllamaGenerateRequest` in `docs/data-models.md`. Requires `model` (from `.env` `OLLAMA_MODEL`), `prompt`, and `stream: false`.
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const ollamaUrl =
-        process.env.OLLAMA_ENDPOINT_URL || "http://localhost:11434";
-      const requestBody: OllamaGenerateRequest = {
-        model: process.env.OLLAMA_MODEL || "llama3",
-        prompt: "Summarize this text: ...",
-        stream: false,
-      };
-      const response = await fetch(`${ollamaUrl}/api/generate`, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(requestBody),
-      });
-      const data: OllamaGenerateResponse | { error: string } =
-        await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See `OllamaGenerateResponse` in `docs/data-models.md`. Key field is `response` containing the generated text.
-    - Error Response Schema(s): May return non-200 status codes or a `200 OK` with a JSON body like `{ "error": "error message..." }` (e.g., if the model is unavailable).
-
-- **Rate Limits:** N/A for a typical local instance. Performance depends on local hardware.
-- **Link to Official Docs:** [https://github.com/ollama/ollama/blob/main/docs/api.md](https://github.com/ollama/ollama/blob/main/docs/api.md)
-
-## Internal APIs Provided
-
-- **N/A:** The application is a self-contained CLI tool and does not expose any APIs for other services to consume.
-
-## Cloud Service SDK Usage
-
-- **N/A:** The application runs locally and uses the native Node.js `Workspace` API for HTTP requests, not cloud provider SDKs.
-
-## Change Log
-
-| Change        | Date       | Version | Description                     | Author      |
-| ------------- | ---------- | ------- | ------------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Epics/Models | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/api-reference.txt

@@ -1,97 +0,0 @@
-# BMad Hacker Daily Digest API Reference
-
-This document describes the external APIs consumed by the BMad Hacker Daily Digest application.
-
-## External APIs Consumed
-
-### Algolia Hacker News (HN) Search API
-
-- **Purpose:** Used to fetch the top Hacker News stories and the comments associated with each story.
-- **Base URL:** `http://hn.algolia.com/api/v1`
-- **Authentication:** None required for public search endpoints.
-- **Key Endpoints Used:**
-
-  - **`GET /search` (for Top Stories)**
-
-    - Description: Retrieves stories based on search parameters. Used here to get top stories from the front page.
-    - Request Parameters:
-      - `tags=front_page`: Required to filter for front-page stories.
-      - `hitsPerPage=10`: Specifies the number of stories to retrieve (adjust as needed, default is typically 20).
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const url =
-        "[http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10](http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10)";
-      const response = await fetch(url);
-      const data = await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See "Algolia HN API - Story Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing story objects.
-    - Error Response Schema(s): Standard HTTP errors (e.g., 4xx, 5xx). May return JSON with an error message.
-
-  - **`GET /search` (for Comments)**
-    - Description: Retrieves comments associated with a specific story ID.
-    - Request Parameters:
-      - `tags=comment,story_{storyId}`: Required to filter for comments belonging to the specified `storyId`. Replace `{storyId}` with the actual ID (e.g., `story_12345`).
-      - `hitsPerPage={maxComments}`: Specifies the maximum number of comments to retrieve (value from `.env` `MAX_COMMENTS_PER_STORY`).
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const storyId = "..."; // HN Story ID
-      const maxComments = 50; // From config
-      const url = `http://hn.algolia.com/api/v1/search?tags=comment,story_${storyId}&hitsPerPage=${maxComments}`;
-      const response = await fetch(url);
-      const data = await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See "Algolia HN API - Comment Response Subset" in `docs/data-models.md`. Primarily interested in the `hits` array containing comment objects.
-    - Error Response Schema(s): Standard HTTP errors.
-
-- **Rate Limits:** Subject to Algolia's public API rate limits (typically generous for HN search but not explicitly defined/guaranteed). Implementations should handle potential 429 errors gracefully if encountered.
-- **Link to Official Docs:** [https://hn.algolia.com/api](https://hn.algolia.com/api)
-
-### Ollama API (Local Instance)
-
-- **Purpose:** Used to generate text summaries for scraped article content and HN comment discussions using a locally running LLM.
-- **Base URL:** Configurable via the `OLLAMA_ENDPOINT_URL` environment variable (e.g., `http://localhost:11434`).
-- **Authentication:** None typically required for default local installations.
-- **Key Endpoints Used:**
-
-  - **`POST /api/generate`**
-    - Description: Generates text based on a model and prompt. Used here for summarization.
-    - Request Body Schema: See `OllamaGenerateRequest` in `docs/data-models.md`. Requires `model` (from `.env` `OLLAMA_MODEL`), `prompt`, and `stream: false`.
-    - Example Request (Conceptual using native `Workspace`):
-      ```typescript
-      // Using Node.js native Workspace API
-      const ollamaUrl =
-        process.env.OLLAMA_ENDPOINT_URL || "http://localhost:11434";
-      const requestBody: OllamaGenerateRequest = {
-        model: process.env.OLLAMA_MODEL || "llama3",
-        prompt: "Summarize this text: ...",
-        stream: false,
-      };
-      const response = await fetch(`${ollamaUrl}/api/generate`, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify(requestBody),
-      });
-      const data: OllamaGenerateResponse | { error: string } =
-        await response.json();
-      ```
-    - Success Response Schema (Code: `200 OK`): See `OllamaGenerateResponse` in `docs/data-models.md`. Key field is `response` containing the generated text.
-    - Error Response Schema(s): May return non-200 status codes or a `200 OK` with a JSON body like `{ "error": "error message..." }` (e.g., if the model is unavailable).
-
-- **Rate Limits:** N/A for a typical local instance. Performance depends on local hardware.
-- **Link to Official Docs:** [https://github.com/ollama/ollama/blob/main/docs/api.md](https://github.com/ollama/ollama/blob/main/docs/api.md)
-
-## Internal APIs Provided
-
-- **N/A:** The application is a self-contained CLI tool and does not expose any APIs for other services to consume.
-
-## Cloud Service SDK Usage
-
-- **N/A:** The application runs locally and uses the native Node.js `Workspace` API for HTTP requests, not cloud provider SDKs.
-
-## Change Log
-
-| Change        | Date       | Version | Description                     | Author      |
-| ------------- | ---------- | ------- | ------------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Epics/Models | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/architecture.md

@@ -1,254 +0,0 @@
-# BMad Hacker Daily Digest Architecture Document
-
-## Technical Summary
-
-The BMad Hacker Daily Digest is a command-line interface (CLI) tool designed to provide users with concise summaries of top Hacker News (HN) stories and their associated comment discussions . Built with TypeScript and Node.js (v22) , it operates entirely on the user's local machine . The core functionality involves a sequential pipeline: fetching story and comment data from the Algolia HN Search API , attempting to scrape linked article content , generating summaries using a local Ollama LLM instance , persisting intermediate data to the local filesystem , and finally assembling and emailing an HTML digest using Nodemailer . The architecture emphasizes modularity and testability, including mandatory standalone scripts for testing each pipeline stage . The project starts from the `bmad-boilerplate` template .
-
-## High-Level Overview
-
-The application follows a simple, sequential pipeline architecture executed via a manual CLI command (`npm run dev` or `npm start`) . There is no persistent database; the local filesystem is used to store intermediate data artifacts (fetched data, scraped text, summaries) between steps within a date-stamped directory . All external HTTP communication (Algolia API, article scraping, Ollama API) utilizes the native Node.js `Workspace` API .
-
-```mermaid
-graph LR
-    subgraph "BMad Hacker Daily Digest (Local CLI)"
-        A[index.ts / CLI Trigger] --> B(core/pipeline.ts);
-        B --> C{Fetch HN Data};
-        B --> D{Scrape Articles};
-        B --> E{Summarize Content};
-        B --> F{Assemble & Email Digest};
-        C --> G["Local FS (_data.json)"];
-        D --> H["Local FS (_article.txt)"];
-        E --> I["Local FS (_summary.json)"];
-        F --> G;
-        F --> H;
-        F --> I;
-    end
-
-    subgraph External Services
-        X[Algolia HN API];
-        Y[Article Websites];
-        Z["Ollama API (Local)"];
-        W[SMTP Service];
-    end
-
-    C --> X;
-    D --> Y;
-    E --> Z;
-    F --> W;
-
-    style G fill:#eee,stroke:#333,stroke-width:1px
-    style H fill:#eee,stroke:#333,stroke-width:1px
-    style I fill:#eee,stroke:#333,stroke-width:1px
-```
-
-## Component View
-
-The application code (`src/`) is organized into logical modules based on the defined project structure (`docs/project-structure.md`). Key components include:
-
-- **`src/index.ts`**: The main entry point, handling CLI invocation and initiating the pipeline.
-- **`src/core/pipeline.ts`**: Orchestrates the sequential execution of the main pipeline stages (fetch, scrape, summarize, email).
-- **`src/clients/`**: Modules responsible for interacting with external APIs.
-  - `algoliaHNClient.ts`: Communicates with the Algolia HN Search API.
-  - `ollamaClient.ts`: Communicates with the local Ollama API.
-- **`src/scraper/articleScraper.ts`**: Handles fetching and extracting text content from article URLs.
-- **`src/email/`**: Manages digest assembly, HTML rendering, and email dispatch via Nodemailer.
-  - `contentAssembler.ts`: Reads persisted data.
-  - `templates.ts`: Renders HTML.
-  - `emailSender.ts`: Sends the email.
-- **`src/stages/`**: Contains standalone scripts (`Workspace_hn_data.ts`, `scrape_articles.ts`, etc.) for testing individual pipeline stages independently using local data where applicable.
-- **`src/utils/`**: Shared utilities for configuration loading (`config.ts`), logging (`logger.ts`), and date handling (`dateUtils.ts`).
-- **`src/types/`**: Shared TypeScript interfaces and types.
-
-```mermaid
-graph TD
-    subgraph AppComponents ["Application Components (src/)"]
-        Idx(index.ts) --> Pipe(core/pipeline.ts);
-        Pipe --> HNClient(clients/algoliaHNClient.ts);
-        Pipe --> Scraper(scraper/articleScraper.ts);
-        Pipe --> OllamaClient(clients/ollamaClient.ts);
-        Pipe --> Assembler(email/contentAssembler.ts);
-        Pipe --> Renderer(email/templates.ts);
-        Pipe --> Sender(email/emailSender.ts);
-
-        Pipe --> Utils(utils/*);
-        Pipe --> Types(types/*);
-        HNClient --> Types;
-        OllamaClient --> Types;
-        Assembler --> Types;
-        Renderer --> Types;
-
-        subgraph StageRunnersSubgraph ["Stage Runners (src/stages/)"]
-            SFetch(fetch_hn_data.ts) --> HNClient;
-            SFetch --> Utils;
-            SScrape(scrape_articles.ts) --> Scraper;
-            SScrape --> Utils;
-            SSummarize(summarize_content.ts) --> OllamaClient;
-            SSummarize --> Utils;
-            SEmail(send_digest.ts) --> Assembler;
-            SEmail --> Renderer;
-            SEmail --> Sender;
-            SEmail --> Utils;
-        end
-    end
-
-    subgraph Externals ["Filesystem & External"]
-        FS["Local Filesystem (output/)"]
-        Algolia((Algolia HN API))
-        Websites((Article Websites))
-        Ollama["Ollama API (Local)"]
-        SMTP((SMTP Service))
-    end
-
-    HNClient --> Algolia;
-    Scraper --> Websites;
-    OllamaClient --> Ollama;
-    Sender --> SMTP;
-
-    Pipe --> FS;
-    Assembler --> FS;
-
-    SFetch --> FS;
-    SScrape --> FS;
-    SSummarize --> FS;
-    SEmail --> FS;
-
-    %% Apply style to the subgraph using its ID after the block
-    style StageRunnersSubgraph fill:#f9f,stroke:#333,stroke-width:1px
-```
-
-## Key Architectural Decisions & Patterns
-
-- **Architecture Style:** Simple Sequential Pipeline executed via CLI.
-- **Execution Environment:** Local machine only; no cloud deployment, no database for MVP.
-- **Data Handling:** Intermediate data persisted to local filesystem in a date-stamped directory.
-- **HTTP Client:** Mandatory use of native Node.js v22 `Workspace` API for all external HTTP requests.
-- **Modularity:** Code organized into distinct modules for clients, scraping, email, core logic, utilities, and types to promote separation of concerns and testability.
-- **Stage Testing:** Mandatory standalone scripts (`src/stages/*`) allow independent testing of each pipeline phase.
-- **Configuration:** Environment variables loaded natively from `.env` file; no `dotenv` package required.
-- **Error Handling:** Graceful handling of scraping failures (log and continue); basic logging for other API/network errors.
-- **Logging:** Basic console logging via a simple wrapper (`src/utils/logger.ts`) for MVP; structured file logging is a post-MVP consideration.
-- **Key Libraries:** `@extractus/article-extractor`, `date-fns`, `nodemailer`, `yargs`. (See `docs/tech-stack.md`)
-
-## Core Workflow / Sequence Diagram (Main Pipeline)
-
-```mermaid
-sequenceDiagram
-    participant CLI_User as CLI User
-    participant Idx as src/index.ts
-    participant Pipe as core/pipeline.ts
-    participant Cfg as utils/config.ts
-    participant Log as utils/logger.ts
-    participant HN as clients/algoliaHNClient.ts
-    participant FS as Local FS [output/]
-    participant Scr as scraper/articleScraper.ts
-    participant Oll as clients/ollamaClient.ts
-    participant Asm as email/contentAssembler.ts
-    participant Tpl as email/templates.ts
-    participant Snd as email/emailSender.ts
-    participant Alg as Algolia HN API
-    participant Web as Article Website
-    participant Olm as Ollama API [Local]
-    participant SMTP as SMTP Service
-
-    Note right of CLI_User: Triggered via 'npm run dev'/'start'
-
-    CLI_User ->> Idx: Execute script
-    Idx ->> Cfg: Load .env config
-    Idx ->> Log: Initialize logger
-    Idx ->> Pipe: runPipeline()
-    Pipe ->> Log: Log start
-    Pipe ->> HN: fetchTopStories()
-    HN ->> Alg: Request stories
-    Alg -->> HN: Story data
-    HN -->> Pipe: stories[]
-    loop For each story
-        Pipe ->> HN: fetchCommentsForStory(storyId, max)
-        HN ->> Alg: Request comments
-        Alg -->> HN: Comment data
-        HN -->> Pipe: comments[]
-        Pipe ->> FS: Write {storyId}_data.json
-    end
-    Pipe ->> Log: Log HN fetch complete
-
-    loop For each story with URL
-        Pipe ->> Scr: scrapeArticle(story.url)
-        Scr ->> Web: Request article HTML [via Workspace]
-        alt Scraping Successful
-            Web -->> Scr: HTML content
-            Scr -->> Pipe: articleText: string
-            Pipe ->> FS: Write {storyId}_article.txt
-        else Scraping Failed / Skipped
-            Web -->> Scr: Error / Non-HTML / Timeout
-            Scr -->> Pipe: articleText: null
-            Pipe ->> Log: Log scraping failure/skip
-        end
-    end
-    Pipe ->> Log: Log scraping complete
-
-    loop For each story
-        alt Article content exists
-            Pipe ->> Oll: generateSummary(prompt, articleText)
-            Oll ->> Olm: POST /api/generate [article]
-            Olm -->> Oll: Article Summary / Error
-            Oll -->> Pipe: articleSummary: string | null
-        else No article content
-            Pipe -->> Pipe: Set articleSummary = null
-        end
-        alt Comments exist
-            Pipe ->> Pipe: Format comments to text block
-            Pipe ->> Oll: generateSummary(prompt, commentsText)
-            Oll ->> Olm: POST /api/generate [comments]
-            Olm -->> Oll: Discussion Summary / Error
-            Oll -->> Pipe: discussionSummary: string | null
-        else No comments
-            Pipe -->> Pipe: Set discussionSummary = null
-        end
-        Pipe ->> FS: Write {storyId}_summary.json
-    end
-    Pipe ->> Log: Log summarization complete
-
-    Pipe ->> Asm: assembleDigestData(dateDirPath)
-    Asm ->> FS: Read _data.json, _summary.json files
-    FS -->> Asm: File contents
-    Asm -->> Pipe: digestData[]
-    alt Digest data assembled
-        Pipe ->> Tpl: renderDigestHtml(digestData, date)
-        Tpl -->> Pipe: htmlContent: string
-        Pipe ->> Snd: sendDigestEmail(subject, htmlContent)
-        Snd ->> Cfg: Load email config
-        Snd ->> SMTP: Send email
-        SMTP -->> Snd: Success/Failure
-        Snd -->> Pipe: success: boolean
-        Pipe ->> Log: Log email result
-    else Assembly failed / No data
-        Pipe ->> Log: Log skipping email
-    end
-    Pipe ->> Log: Log finished
-```
-
-## Infrastructure and Deployment Overview
-
-- **Cloud Provider(s):** N/A. Executes locally on the user's machine.
-- **Core Services Used:** N/A (relies on external Algolia API, local Ollama, target websites, SMTP provider).
-- **Infrastructure as Code (IaC):** N/A.
-- **Deployment Strategy:** Manual execution via CLI (`npm run dev` or `npm run start` after `npm run build`). No CI/CD pipeline required for MVP.
-- **Environments:** Single environment: local development machine.
-
-## Key Reference Documents
-
-- `docs/prd.md`
-- `docs/epic1.md` ... `docs/epic5.md`
-- `docs/tech-stack.md`
-- `docs/project-structure.md`
-- `docs/data-models.md`
-- `docs/api-reference.md`
-- `docs/environment-vars.md`
-- `docs/coding-standards.md`
-- `docs/testing-strategy.md`
-- `docs/prompts.md`
-
-## Change Log
-
-| Change        | Date       | Version | Description                | Author      |
-| ------------- | ---------- | ------- | -------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on PRD | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/architecture.txt

@@ -1,254 +0,0 @@
-# BMad Hacker Daily Digest Architecture Document
-
-## Technical Summary
-
-The BMad Hacker Daily Digest is a command-line interface (CLI) tool designed to provide users with concise summaries of top Hacker News (HN) stories and their associated comment discussions . Built with TypeScript and Node.js (v22) , it operates entirely on the user's local machine . The core functionality involves a sequential pipeline: fetching story and comment data from the Algolia HN Search API , attempting to scrape linked article content , generating summaries using a local Ollama LLM instance , persisting intermediate data to the local filesystem , and finally assembling and emailing an HTML digest using Nodemailer . The architecture emphasizes modularity and testability, including mandatory standalone scripts for testing each pipeline stage . The project starts from the `bmad-boilerplate` template .
-
-## High-Level Overview
-
-The application follows a simple, sequential pipeline architecture executed via a manual CLI command (`npm run dev` or `npm start`) . There is no persistent database; the local filesystem is used to store intermediate data artifacts (fetched data, scraped text, summaries) between steps within a date-stamped directory . All external HTTP communication (Algolia API, article scraping, Ollama API) utilizes the native Node.js `Workspace` API .
-
-```mermaid
-graph LR
-    subgraph "BMad Hacker Daily Digest (Local CLI)"
-        A[index.ts / CLI Trigger] --> B(core/pipeline.ts);
-        B --> C{Fetch HN Data};
-        B --> D{Scrape Articles};
-        B --> E{Summarize Content};
-        B --> F{Assemble & Email Digest};
-        C --> G["Local FS (_data.json)"];
-        D --> H["Local FS (_article.txt)"];
-        E --> I["Local FS (_summary.json)"];
-        F --> G;
-        F --> H;
-        F --> I;
-    end
-
-    subgraph External Services
-        X[Algolia HN API];
-        Y[Article Websites];
-        Z["Ollama API (Local)"];
-        W[SMTP Service];
-    end
-
-    C --> X;
-    D --> Y;
-    E --> Z;
-    F --> W;
-
-    style G fill:#eee,stroke:#333,stroke-width:1px
-    style H fill:#eee,stroke:#333,stroke-width:1px
-    style I fill:#eee,stroke:#333,stroke-width:1px
-```
-
-## Component View
-
-The application code (`src/`) is organized into logical modules based on the defined project structure (`docs/project-structure.md`). Key components include:
-
-- **`src/index.ts`**: The main entry point, handling CLI invocation and initiating the pipeline.
-- **`src/core/pipeline.ts`**: Orchestrates the sequential execution of the main pipeline stages (fetch, scrape, summarize, email).
-- **`src/clients/`**: Modules responsible for interacting with external APIs.
-  - `algoliaHNClient.ts`: Communicates with the Algolia HN Search API.
-  - `ollamaClient.ts`: Communicates with the local Ollama API.
-- **`src/scraper/articleScraper.ts`**: Handles fetching and extracting text content from article URLs.
-- **`src/email/`**: Manages digest assembly, HTML rendering, and email dispatch via Nodemailer.
-  - `contentAssembler.ts`: Reads persisted data.
-  - `templates.ts`: Renders HTML.
-  - `emailSender.ts`: Sends the email.
-- **`src/stages/`**: Contains standalone scripts (`Workspace_hn_data.ts`, `scrape_articles.ts`, etc.) for testing individual pipeline stages independently using local data where applicable.
-- **`src/utils/`**: Shared utilities for configuration loading (`config.ts`), logging (`logger.ts`), and date handling (`dateUtils.ts`).
-- **`src/types/`**: Shared TypeScript interfaces and types.
-
-```mermaid
-graph TD
-    subgraph AppComponents ["Application Components (src/)"]
-        Idx(index.ts) --> Pipe(core/pipeline.ts);
-        Pipe --> HNClient(clients/algoliaHNClient.ts);
-        Pipe --> Scraper(scraper/articleScraper.ts);
-        Pipe --> OllamaClient(clients/ollamaClient.ts);
-        Pipe --> Assembler(email/contentAssembler.ts);
-        Pipe --> Renderer(email/templates.ts);
-        Pipe --> Sender(email/emailSender.ts);
-
-        Pipe --> Utils(utils/*);
-        Pipe --> Types(types/*);
-        HNClient --> Types;
-        OllamaClient --> Types;
-        Assembler --> Types;
-        Renderer --> Types;
-
-        subgraph StageRunnersSubgraph ["Stage Runners (src/stages/)"]
-            SFetch(fetch_hn_data.ts) --> HNClient;
-            SFetch --> Utils;
-            SScrape(scrape_articles.ts) --> Scraper;
-            SScrape --> Utils;
-            SSummarize(summarize_content.ts) --> OllamaClient;
-            SSummarize --> Utils;
-            SEmail(send_digest.ts) --> Assembler;
-            SEmail --> Renderer;
-            SEmail --> Sender;
-            SEmail --> Utils;
-        end
-    end
-
-    subgraph Externals ["Filesystem & External"]
-        FS["Local Filesystem (output/)"]
-        Algolia((Algolia HN API))
-        Websites((Article Websites))
-        Ollama["Ollama API (Local)"]
-        SMTP((SMTP Service))
-    end
-
-    HNClient --> Algolia;
-    Scraper --> Websites;
-    OllamaClient --> Ollama;
-    Sender --> SMTP;
-
-    Pipe --> FS;
-    Assembler --> FS;
-
-    SFetch --> FS;
-    SScrape --> FS;
-    SSummarize --> FS;
-    SEmail --> FS;
-
-    %% Apply style to the subgraph using its ID after the block
-    style StageRunnersSubgraph fill:#f9f,stroke:#333,stroke-width:1px
-```
-
-## Key Architectural Decisions & Patterns
-
-- **Architecture Style:** Simple Sequential Pipeline executed via CLI.
-- **Execution Environment:** Local machine only; no cloud deployment, no database for MVP.
-- **Data Handling:** Intermediate data persisted to local filesystem in a date-stamped directory.
-- **HTTP Client:** Mandatory use of native Node.js v22 `Workspace` API for all external HTTP requests.
-- **Modularity:** Code organized into distinct modules for clients, scraping, email, core logic, utilities, and types to promote separation of concerns and testability.
-- **Stage Testing:** Mandatory standalone scripts (`src/stages/*`) allow independent testing of each pipeline phase.
-- **Configuration:** Environment variables loaded natively from `.env` file; no `dotenv` package required.
-- **Error Handling:** Graceful handling of scraping failures (log and continue); basic logging for other API/network errors.
-- **Logging:** Basic console logging via a simple wrapper (`src/utils/logger.ts`) for MVP; structured file logging is a post-MVP consideration.
-- **Key Libraries:** `@extractus/article-extractor`, `date-fns`, `nodemailer`, `yargs`. (See `docs/tech-stack.md`)
-
-## Core Workflow / Sequence Diagram (Main Pipeline)
-
-```mermaid
-sequenceDiagram
-    participant CLI_User as CLI User
-    participant Idx as src/index.ts
-    participant Pipe as core/pipeline.ts
-    participant Cfg as utils/config.ts
-    participant Log as utils/logger.ts
-    participant HN as clients/algoliaHNClient.ts
-    participant FS as Local FS [output/]
-    participant Scr as scraper/articleScraper.ts
-    participant Oll as clients/ollamaClient.ts
-    participant Asm as email/contentAssembler.ts
-    participant Tpl as email/templates.ts
-    participant Snd as email/emailSender.ts
-    participant Alg as Algolia HN API
-    participant Web as Article Website
-    participant Olm as Ollama API [Local]
-    participant SMTP as SMTP Service
-
-    Note right of CLI_User: Triggered via 'npm run dev'/'start'
-
-    CLI_User ->> Idx: Execute script
-    Idx ->> Cfg: Load .env config
-    Idx ->> Log: Initialize logger
-    Idx ->> Pipe: runPipeline()
-    Pipe ->> Log: Log start
-    Pipe ->> HN: fetchTopStories()
-    HN ->> Alg: Request stories
-    Alg -->> HN: Story data
-    HN -->> Pipe: stories[]
-    loop For each story
-        Pipe ->> HN: fetchCommentsForStory(storyId, max)
-        HN ->> Alg: Request comments
-        Alg -->> HN: Comment data
-        HN -->> Pipe: comments[]
-        Pipe ->> FS: Write {storyId}_data.json
-    end
-    Pipe ->> Log: Log HN fetch complete
-
-    loop For each story with URL
-        Pipe ->> Scr: scrapeArticle(story.url)
-        Scr ->> Web: Request article HTML [via Workspace]
-        alt Scraping Successful
-            Web -->> Scr: HTML content
-            Scr -->> Pipe: articleText: string
-            Pipe ->> FS: Write {storyId}_article.txt
-        else Scraping Failed / Skipped
-            Web -->> Scr: Error / Non-HTML / Timeout
-            Scr -->> Pipe: articleText: null
-            Pipe ->> Log: Log scraping failure/skip
-        end
-    end
-    Pipe ->> Log: Log scraping complete
-
-    loop For each story
-        alt Article content exists
-            Pipe ->> Oll: generateSummary(prompt, articleText)
-            Oll ->> Olm: POST /api/generate [article]
-            Olm -->> Oll: Article Summary / Error
-            Oll -->> Pipe: articleSummary: string | null
-        else No article content
-            Pipe -->> Pipe: Set articleSummary = null
-        end
-        alt Comments exist
-            Pipe ->> Pipe: Format comments to text block
-            Pipe ->> Oll: generateSummary(prompt, commentsText)
-            Oll ->> Olm: POST /api/generate [comments]
-            Olm -->> Oll: Discussion Summary / Error
-            Oll -->> Pipe: discussionSummary: string | null
-        else No comments
-            Pipe -->> Pipe: Set discussionSummary = null
-        end
-        Pipe ->> FS: Write {storyId}_summary.json
-    end
-    Pipe ->> Log: Log summarization complete
-
-    Pipe ->> Asm: assembleDigestData(dateDirPath)
-    Asm ->> FS: Read _data.json, _summary.json files
-    FS -->> Asm: File contents
-    Asm -->> Pipe: digestData[]
-    alt Digest data assembled
-        Pipe ->> Tpl: renderDigestHtml(digestData, date)
-        Tpl -->> Pipe: htmlContent: string
-        Pipe ->> Snd: sendDigestEmail(subject, htmlContent)
-        Snd ->> Cfg: Load email config
-        Snd ->> SMTP: Send email
-        SMTP -->> Snd: Success/Failure
-        Snd -->> Pipe: success: boolean
-        Pipe ->> Log: Log email result
-    else Assembly failed / No data
-        Pipe ->> Log: Log skipping email
-    end
-    Pipe ->> Log: Log finished
-```
-
-## Infrastructure and Deployment Overview
-
-- **Cloud Provider(s):** N/A. Executes locally on the user's machine.
-- **Core Services Used:** N/A (relies on external Algolia API, local Ollama, target websites, SMTP provider).
-- **Infrastructure as Code (IaC):** N/A.
-- **Deployment Strategy:** Manual execution via CLI (`npm run dev` or `npm run start` after `npm run build`). No CI/CD pipeline required for MVP.
-- **Environments:** Single environment: local development machine.
-
-## Key Reference Documents
-
-- `docs/prd.md`
-- `docs/epic1.md` ... `docs/epic5.md`
-- `docs/tech-stack.md`
-- `docs/project-structure.md`
-- `docs/data-models.md`
-- `docs/api-reference.md`
-- `docs/environment-vars.md`
-- `docs/coding-standards.md`
-- `docs/testing-strategy.md`
-- `docs/prompts.md`
-
-## Change Log
-
-| Change        | Date       | Version | Description                | Author      |
-| ------------- | ---------- | ------- | -------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on PRD | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/botched-architecture-draft.md

@@ -1,226 +0,0 @@
-# BMad Hacker Daily Digest Architecture Document
-
-## Technical Summary
-
-This document outlines the technical architecture for the BMad Hacker Daily Digest, a command-line tool built with TypeScript and Node.js v22. It adheres to the structure provided by the "bmad-boilerplate". The system fetches the top 10 Hacker News stories and their comments daily via the Algolia HN API, attempts to scrape linked articles, generates summaries for both articles (if scraped) and discussions using a local Ollama instance, persists intermediate data locally, and sends an HTML digest email via Nodemailer upon manual CLI execution. The architecture emphasizes modularity through distinct clients and processing stages, facilitating independent stage testing as required by the PRD. Execution is strictly local for the MVP.
-
-## High-Level Overview
-
-The application follows a sequential pipeline architecture triggered by a single CLI command (`npm run dev` or `npm start`). Data flows through distinct stages: HN Data Acquisition, Article Scraping, LLM Summarization, and Digest Assembly/Email Dispatch. Each stage persists its output to a date-stamped local directory, allowing subsequent stages to operate on this data and enabling stage-specific testing utilities.
-
-**(Diagram Suggestion for Canvas: Create a flowchart showing the stages below)**
-
-```mermaid
-graph TD
-    A[CLI Trigger (npm run dev/start)] --> B(Initialize: Load Config, Setup Logger, Create Output Dir);
-    B --> C{Fetch HN Data (Top 10 Stories + Comments)};
-    C -- Story/Comment Data --> D(Persist HN Data: ./output/YYYY-MM-DD/{storyId}_data.json);
-    D --> E{Attempt Article Scraping (per story)};
-    E -- Scraped Text (if successful) --> F(Persist Article Text: ./output/YYYY-MM-DD/{storyId}_article.txt);
-    F --> G{Generate Summaries (Article + Discussion via Ollama)};
-    G -- Summaries --> H(Persist Summaries: ./output/YYYY-MM-DD/{storyId}_summary.json);
-    H --> I{Assemble Digest (Read persisted data)};
-    I -- HTML Content --> J{Send Email via Nodemailer};
-    J --> K(Log Final Status & Exit);
-
-    subgraph Stage Testing Utilities
-        direction LR
-        T1[npm run stage:fetch] --> D;
-        T2[npm run stage:scrape] --> F;
-        T3[npm run stage:summarize] --> H;
-        T4[npm run stage:email] --> J;
-    end
-
-    C --> |Error/Skip| G;  // If no comments
-    E --> |Skip/Fail| G;  // If no URL or scrape fails
-    G --> |Summarization Fail| H; // Persist null summaries
-    I --> |Assembly Fail| K; // Skip email if assembly fails
-```
-
-## Component View
-
-The application logic resides primarily within the `src/` directory, organized into modules responsible for specific pipeline stages or cross-cutting concerns.
-
-**(Diagram Suggestion for Canvas: Create a component diagram showing modules and dependencies)**
-
-```mermaid
-graph TD
-    subgraph src ["Source Code (src/)"]
-        direction LR
-        Entry["index.ts (Main Orchestrator)"]
-
-        subgraph Config ["Configuration"]
-            ConfMod["config.ts"]
-            EnvFile[".env File"]
-        end
-
-        subgraph Utils ["Utilities"]
-            Logger["logger.ts"]
-        end
-
-        subgraph Clients ["External Service Clients"]
-            Algolia["clients/algoliaHNClient.ts"]
-            Ollama["clients/ollamaClient.ts"]
-        end
-
-        Scraper["scraper/articleScraper.ts"]
-
-        subgraph Email ["Email Handling"]
-            Assembler["email/contentAssembler.ts"]
-            Templater["email/templater.ts (or within Assembler)"]
-            Sender["email/emailSender.ts"]
-            Nodemailer["(nodemailer library)"]
-        end
-
-        subgraph Stages ["Stage Testing Scripts (src/stages/)"]
-             FetchStage["fetch_hn_data.ts"]
-             ScrapeStage["scrape_articles.ts"]
-             SummarizeStage["summarize_content.ts"]
-             SendStage["send_digest.ts"]
-        end
-
-        Entry --> ConfMod;
-        Entry --> Logger;
-        Entry --> Algolia;
-        Entry --> Scraper;
-        Entry --> Ollama;
-        Entry --> Assembler;
-        Entry --> Templater;
-        Entry --> Sender;
-
-        Algolia -- uses --> NativeFetch["Node.js v22 Native Workspace"];
-        Ollama -- uses --> NativeFetch;
-        Scraper -- uses --> NativeFetch;
-        Scraper -- uses --> ArticleExtractor["(@extractus/article-extractor)"];
-        Sender -- uses --> Nodemailer;
-        ConfMod -- reads --> EnvFile;
-
-        Assembler -- reads --> LocalFS["Local Filesystem (./output)"];
-        Entry -- writes --> LocalFS;
-
-        FetchStage --> Algolia;
-        FetchStage --> LocalFS;
-        ScrapeStage --> Scraper;
-        ScrapeStage --> LocalFS;
-        SummarizeStage --> Ollama;
-        SummarizeStage --> LocalFS;
-        SendStage --> Assembler;
-        SendStage --> Templater;
-        SendStage --> Sender;
-        SendStage --> LocalFS;
-    end
-
-    CLI["CLI (npm run ...)"] --> Entry;
-    CLI -- runs --> FetchStage;
-    CLI -- runs --> ScrapeStage;
-    CLI -- runs --> SummarizeStage;
-    CLI -- runs --> SendStage;
-
-```
-
-_Module Descriptions:_
-
-- **`src/index.ts`**: The main entry point, orchestrating the entire pipeline flow from initialization to final email dispatch. Imports and calls functions from other modules.
-- **`src/config.ts`**: Responsible for loading and validating environment variables from the `.env` file using the `dotenv` library.
-- **`src/logger.ts`**: Provides a simple console logging utility used throughout the application.
-- **`src/clients/algoliaHNClient.ts`**: Encapsulates interaction with the Algolia Hacker News Search API using the native `Workspace` API for fetching stories and comments.
-- **`src/clients/ollamaClient.ts`**: Encapsulates interaction with the local Ollama API endpoint using the native `Workspace` API for generating summaries.
-- **`src/scraper/articleScraper.ts`**: Handles fetching article HTML using native `Workspace` and extracting text content using `@extractus/article-extractor`. Includes robust error handling for fetch and extraction failures.
-- **`src/email/contentAssembler.ts`**: Reads persisted story data and summaries from the local output directory.
-- **`src/email/templater.ts` (or integrated)**: Renders the HTML email content using the assembled data.
-- **`src/email/emailSender.ts`**: Configures and uses Nodemailer to send the generated HTML email.
-- **`src/stages/*.ts`**: Individual scripts designed to run specific pipeline stages independently for testing, using persisted data from previous stages as input where applicable.
-
-## Key Architectural Decisions & Patterns
-
-- **Pipeline Architecture:** A sequential flow where each stage processes data and passes artifacts to the next via the local filesystem. Chosen for simplicity and to easily support independent stage testing.
-- **Local Execution & File Persistence:** All execution is local, and intermediate artifacts (`_data.json`, `_article.txt`, `_summary.json`) are stored in a date-stamped `./output` directory. This avoids database setup for MVP and facilitates debugging/stage testing.
-- **Native `Workspace` API:** Mandated by constraints for all HTTP requests (Algolia, Ollama, Article Scraping). Ensures usage of the latest Node.js features.
-- **Modular Clients:** External interactions (Algolia, Ollama) are encapsulated in dedicated client modules (`src/clients/`). This promotes separation of concerns and makes swapping implementations (e.g., different LLM API) easier.
-- **Configuration via `.env`:** Standard approach using `dotenv` for managing API keys, endpoints, and behavioral parameters (as per boilerplate).
-- **Stage Testing Utilities:** Dedicated scripts (`src/stages/*.ts`) allow isolated testing of fetching, scraping, summarization, and emailing, fulfilling a key PRD requirement.
-- **Graceful Error Handling (Scraping):** Article scraping failures are logged but do not halt the main pipeline, allowing the process to continue with discussion summaries only, as required. Other errors (API, LLM) are logged.
-
-## Core Workflow / Sequence Diagrams (Simplified)
-
-**(Diagram Suggestion for Canvas: Create a Sequence Diagram showing interactions)**
-
-```mermaid
-sequenceDiagram
-    participant CLI
-    participant Index as index.ts
-    participant Config as config.ts
-    participant Logger as logger.ts
-    participant OutputDir as Output Dir Setup
-    participant Algolia as algoliaHNClient.ts
-    participant Scraper as articleScraper.ts
-    participant Ollama as ollamaClient.ts
-    participant Assembler as contentAssembler.ts
-    participant Templater as templater.ts
-    participant Sender as emailSender.ts
-    participant FS as Local Filesystem (./output/YYYY-MM-DD)
-
-    CLI->>Index: npm run dev
-    Index->>Config: Load .env vars
-    Index->>Logger: Initialize
-    Index->>OutputDir: Create/Verify Date Dir
-    Index->>Algolia: fetchTopStories()
-    Algolia-->>Index: stories[]
-    loop For Each Story
-        Index->>Algolia: fetchCommentsForStory(storyId, MAX_COMMENTS)
-        Algolia-->>Index: comments[]
-        Index->>FS: Write {storyId}_data.json
-        alt Has Valid story.url
-            Index->>Scraper: scrapeArticle(story.url)
-            Scraper-->>Index: articleContent (string | null)
-            alt Scrape Success
-                Index->>FS: Write {storyId}_article.txt
-            end
-        end
-        alt Has articleContent
-             Index->>Ollama: generateSummary(ARTICLE_PROMPT, articleContent)
-             Ollama-->>Index: articleSummary (string | null)
-        end
-        alt Has comments[]
-             Index->>Ollama: generateSummary(DISCUSSION_PROMPT, formattedComments)
-             Ollama-->>Index: discussionSummary (string | null)
-        end
-        Index->>FS: Write {storyId}_summary.json
-    end
-    Index->>Assembler: assembleDigestData(dateDirPath)
-    Assembler->>FS: Read _data.json, _summary.json files
-    Assembler-->>Index: digestData[]
-    alt digestData is not empty
-        Index->>Templater: renderDigestHtml(digestData, date)
-        Templater-->>Index: htmlContent
-        Index->>Sender: sendDigestEmail(subject, htmlContent)
-        Sender-->>Index: success (boolean)
-    end
-    Index->>Logger: Log final status
-```
-
-## Infrastructure and Deployment Overview
-
-- **Cloud Provider(s):** N/A (Local Machine Execution Only for MVP)
-- **Core Services Used:** N/A
-- **Infrastructure as Code (IaC):** N/A
-- **Deployment Strategy:** Manual CLI execution (`npm run dev` for development with `ts-node`, `npm run build && npm start` for running compiled JS). No automated deployment pipeline for MVP.
-- **Environments:** Single: Local development machine.
-
-## Key Reference Documents
-
-- docs/prd.md
-- docs/epic1-draft.txt, docs/epic2-draft.txt, ... docs/epic5-draft.txt
-- docs/tech-stack.md
-- docs/project-structure.md
-- docs/coding-standards.md
-- docs/api-reference.md
-- docs/data-models.md
-- docs/environment-vars.md
-- docs/testing-strategy.md
-
-## Change Log
-
-| Change        | Date       | Version | Description                        | Author      |
-| ------------- | ---------- | ------- | ---------------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on PRD & Epics | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/coding-standards.md

@@ -1,80 +0,0 @@
-# BMad Hacker Daily Digest Coding Standards and Patterns
-
-This document outlines the coding standards, design patterns, and best practices to be followed during the development of the BMad Hacker Daily Digest project. Adherence to these standards is crucial for maintainability, readability, and collaboration.
-
-## Architectural / Design Patterns Adopted
-
-- **Sequential Pipeline:** The core application follows a linear sequence of steps (fetch, scrape, summarize, email) orchestrated within `src/core/pipeline.ts`.
-- **Modular Design:** The application is broken down into distinct modules based on responsibility (e.g., `clients/`, `scraper/`, `email/`, `utils/`) to promote separation of concerns, testability, and maintainability. See `docs/project-structure.md`.
-- **Client Abstraction:** External service interactions (Algolia, Ollama) are encapsulated within dedicated client modules in `src/clients/`.
-- **Filesystem Persistence:** Intermediate data is persisted to the local filesystem instead of a database, acting as a handoff between pipeline stages.
-
-## Coding Standards
-
-- **Primary Language:** TypeScript (v5.x, as configured in boilerplate)
-- **Primary Runtime:** Node.js (v22.x, as required by PRD )
-- **Style Guide & Linter:** ESLint and Prettier. Configuration is provided by the `bmad-boilerplate`.
-  - **Mandatory:** Run `npm run lint` and `npm run format` regularly and before committing code. Code must be free of lint errors.
-- **Naming Conventions:**
-  - Variables & Functions: `camelCase`
-  - Classes, Types, Interfaces: `PascalCase`
-  - Constants: `UPPER_SNAKE_CASE`
-  - Files: `kebab-case.ts` (e.g., `article-scraper.ts`) or `camelCase.ts` (e.g., `ollamaClient.ts`). Be consistent within module types (e.g., all clients follow one pattern, all utils another). Let's default to `camelCase.ts` for consistency with class/module names where applicable (e.g. `ollamaClient.ts`) and `kebab-case.ts` for more descriptive utils or stage runners (e.g. `Workspace-hn-data.ts`).
-  - Test Files: `*.test.ts` (e.g., `ollamaClient.test.ts`)
-- **File Structure:** Adhere strictly to the layout defined in `docs/project-structure.md`.
-- **Asynchronous Operations:** **Mandatory:** Use `async`/`await` for all asynchronous operations (e.g., native `Workspace` HTTP calls , `fs/promises` file operations, Ollama client calls, Nodemailer `sendMail`). Avoid using raw Promises `.then()`/`.catch()` syntax where `async/await` provides better readability.
-- **Type Safety:** Leverage TypeScript's static typing. Use interfaces and types defined in `src/types/` where appropriate. Assume `strict` mode is enabled in `tsconfig.json` (from boilerplate). Avoid using `any` unless absolutely necessary and justified.
-- **Comments & Documentation:**
-  - Use JSDoc comments for exported functions, classes, and complex logic.
-  - Keep comments concise and focused on the _why_, not the _what_, unless the code is particularly complex.
-  - Update READMEs as needed for setup or usage changes.
-- **Dependency Management:**
-  - Use `npm` for package management.
-  - Keep production dependencies minimal, as required by the PRD . Justify any additions.
-  - Use `devDependencies` for testing, linting, and build tools.
-
-## Error Handling Strategy
-
-- **General Approach:** Use standard JavaScript `try...catch` blocks for operations that can fail (I/O, network requests, parsing, etc.). Throw specific `Error` objects with descriptive messages. Avoid catching errors without logging or re-throwing unless intentionally handling a specific case.
-- **Logging:**
-  - **Mandatory:** Use the central logger utility (`src/utils/logger.ts`) for all console output (INFO, WARN, ERROR). Do not use `console.log` directly in application logic.
-  - **Format:** Basic text format for MVP. Structured JSON logging to files is a post-MVP enhancement.
-  - **Levels:** Use appropriate levels (`logger.info`, `logger.warn`, `logger.error`).
-  - **Context:** Include relevant context in log messages (e.g., Story ID, function name, URL being processed) to aid debugging.
-- **Specific Handling Patterns:**
-  - **External API Calls (Algolia, Ollama via `Workspace`):**
-    - Wrap `Workspace` calls in `try...catch`.
-    - Check `response.ok` status; if false, log the status code and potentially response body text, then treat as an error (e.g., return `null` or throw).
-    - Log network errors caught by the `catch` block.
-    - No automated retries required for MVP.
-  - **Article Scraping (`articleScraper.ts`):**
-    - Wrap `Workspace` and text extraction (`article-extractor`) logic in `try...catch`.
-    - Handle non-2xx responses, timeouts, non-HTML content types, and extraction errors.
-    - **Crucial:** If scraping fails for any reason, log the error/reason using `logger.warn` or `logger.error`, return `null`, and **allow the main pipeline to continue processing the story** (using only comment summary). Do not throw an error that halts the entire application.
-  - **File I/O (`fs` module):**
-    - Wrap `fs` operations (especially writes) in `try...catch`. Log any file system errors using `logger.error`.
-  - **Email Sending (`Nodemailer`):**
-    - Wrap `transporter.sendMail()` in `try...catch`. Log success (including message ID) or failure clearly using the logger.
-  - **Configuration Loading (`config.ts`):**
-    - Check for the presence of all required environment variables at startup. Throw a fatal error and exit if required variables are missing.
-    - **LLM Interaction (Ollama Client):**
-      - **LLM Prompts:** Use the standardized prompts defined in `docs/prompts.md` when interacting with the Ollama client for consistency.
-      - Wrap `generateSummary` calls in `try...catch`. Log errors from the client (which handles API/network issues).
-      - **Comment Truncation:** Before sending comments for discussion summary, check for the `MAX_COMMENT_CHARS_FOR_SUMMARY` env var. If set to a positive number, truncate the combined comment text block to this length. Log a warning if truncation occurs. If not set, send the full text.
-
-## Security Best Practices
-
-- **Input Sanitization/Validation:** While primarily a local tool, validate critical inputs like external URLs (`story.articleUrl`) before attempting to fetch them. Basic checks (e.g., starts with `http://` or `https://`) are sufficient for MVP .
-- **Secrets Management:**
-  - **Mandatory:** Store sensitive data (`EMAIL_USER`, `EMAIL_PASS`) only in the `.env` file.
-  - **Mandatory:** Ensure the `.env` file is included in `.gitignore` and is never committed to version control.
-  - Do not hardcode secrets anywhere in the source code.
-- **Dependency Security:** Periodically run `npm audit` to check for known vulnerabilities in dependencies. Consider enabling Dependabot if using GitHub.
-- **HTTP Client:** Use the native `Workspace` API as required ; avoid introducing less secure or overly complex HTTP client libraries.
-- **Scraping User-Agent:** Set a default User-Agent header in the scraper code (e.g., "BMadHackerDigest/0.1"). Allow overriding this default via the optional SCRAPER_USER_AGENT environment variable. 
-
-## Change Log
-
-| Change        | Date       | Version | Description                 | Author      |
-| ------------- | ---------- | ------- | --------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on Arch | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/coding-standards.txt

@@ -1,80 +0,0 @@
-# BMad Hacker Daily Digest Coding Standards and Patterns
-
-This document outlines the coding standards, design patterns, and best practices to be followed during the development of the BMad Hacker Daily Digest project. Adherence to these standards is crucial for maintainability, readability, and collaboration.
-
-## Architectural / Design Patterns Adopted
-
-- **Sequential Pipeline:** The core application follows a linear sequence of steps (fetch, scrape, summarize, email) orchestrated within `src/core/pipeline.ts`.
-- **Modular Design:** The application is broken down into distinct modules based on responsibility (e.g., `clients/`, `scraper/`, `email/`, `utils/`) to promote separation of concerns, testability, and maintainability. See `docs/project-structure.md`.
-- **Client Abstraction:** External service interactions (Algolia, Ollama) are encapsulated within dedicated client modules in `src/clients/`.
-- **Filesystem Persistence:** Intermediate data is persisted to the local filesystem instead of a database, acting as a handoff between pipeline stages.
-
-## Coding Standards
-
-- **Primary Language:** TypeScript (v5.x, as configured in boilerplate)
-- **Primary Runtime:** Node.js (v22.x, as required by PRD )
-- **Style Guide & Linter:** ESLint and Prettier. Configuration is provided by the `bmad-boilerplate`.
-  - **Mandatory:** Run `npm run lint` and `npm run format` regularly and before committing code. Code must be free of lint errors.
-- **Naming Conventions:**
-  - Variables & Functions: `camelCase`
-  - Classes, Types, Interfaces: `PascalCase`
-  - Constants: `UPPER_SNAKE_CASE`
-  - Files: `kebab-case.ts` (e.g., `article-scraper.ts`) or `camelCase.ts` (e.g., `ollamaClient.ts`). Be consistent within module types (e.g., all clients follow one pattern, all utils another). Let's default to `camelCase.ts` for consistency with class/module names where applicable (e.g. `ollamaClient.ts`) and `kebab-case.ts` for more descriptive utils or stage runners (e.g. `Workspace-hn-data.ts`).
-  - Test Files: `*.test.ts` (e.g., `ollamaClient.test.ts`)
-- **File Structure:** Adhere strictly to the layout defined in `docs/project-structure.md`.
-- **Asynchronous Operations:** **Mandatory:** Use `async`/`await` for all asynchronous operations (e.g., native `Workspace` HTTP calls , `fs/promises` file operations, Ollama client calls, Nodemailer `sendMail`). Avoid using raw Promises `.then()`/`.catch()` syntax where `async/await` provides better readability.
-- **Type Safety:** Leverage TypeScript's static typing. Use interfaces and types defined in `src/types/` where appropriate. Assume `strict` mode is enabled in `tsconfig.json` (from boilerplate). Avoid using `any` unless absolutely necessary and justified.
-- **Comments & Documentation:**
-  - Use JSDoc comments for exported functions, classes, and complex logic.
-  - Keep comments concise and focused on the _why_, not the _what_, unless the code is particularly complex.
-  - Update READMEs as needed for setup or usage changes.
-- **Dependency Management:**
-  - Use `npm` for package management.
-  - Keep production dependencies minimal, as required by the PRD . Justify any additions.
-  - Use `devDependencies` for testing, linting, and build tools.
-
-## Error Handling Strategy
-
-- **General Approach:** Use standard JavaScript `try...catch` blocks for operations that can fail (I/O, network requests, parsing, etc.). Throw specific `Error` objects with descriptive messages. Avoid catching errors without logging or re-throwing unless intentionally handling a specific case.
-- **Logging:**
-  - **Mandatory:** Use the central logger utility (`src/utils/logger.ts`) for all console output (INFO, WARN, ERROR). Do not use `console.log` directly in application logic.
-  - **Format:** Basic text format for MVP. Structured JSON logging to files is a post-MVP enhancement.
-  - **Levels:** Use appropriate levels (`logger.info`, `logger.warn`, `logger.error`).
-  - **Context:** Include relevant context in log messages (e.g., Story ID, function name, URL being processed) to aid debugging.
-- **Specific Handling Patterns:**
-  - **External API Calls (Algolia, Ollama via `Workspace`):**
-    - Wrap `Workspace` calls in `try...catch`.
-    - Check `response.ok` status; if false, log the status code and potentially response body text, then treat as an error (e.g., return `null` or throw).
-    - Log network errors caught by the `catch` block.
-    - No automated retries required for MVP.
-  - **Article Scraping (`articleScraper.ts`):**
-    - Wrap `Workspace` and text extraction (`article-extractor`) logic in `try...catch`.
-    - Handle non-2xx responses, timeouts, non-HTML content types, and extraction errors.
-    - **Crucial:** If scraping fails for any reason, log the error/reason using `logger.warn` or `logger.error`, return `null`, and **allow the main pipeline to continue processing the story** (using only comment summary). Do not throw an error that halts the entire application.
-  - **File I/O (`fs` module):**
-    - Wrap `fs` operations (especially writes) in `try...catch`. Log any file system errors using `logger.error`.
-  - **Email Sending (`Nodemailer`):**
-    - Wrap `transporter.sendMail()` in `try...catch`. Log success (including message ID) or failure clearly using the logger.
-  - **Configuration Loading (`config.ts`):**
-    - Check for the presence of all required environment variables at startup. Throw a fatal error and exit if required variables are missing.
-    - **LLM Interaction (Ollama Client):**
-      - **LLM Prompts:** Use the standardized prompts defined in `docs/prompts.md` when interacting with the Ollama client for consistency.
-      - Wrap `generateSummary` calls in `try...catch`. Log errors from the client (which handles API/network issues).
-      - **Comment Truncation:** Before sending comments for discussion summary, check for the `MAX_COMMENT_CHARS_FOR_SUMMARY` env var. If set to a positive number, truncate the combined comment text block to this length. Log a warning if truncation occurs. If not set, send the full text.
-
-## Security Best Practices
-
-- **Input Sanitization/Validation:** While primarily a local tool, validate critical inputs like external URLs (`story.articleUrl`) before attempting to fetch them. Basic checks (e.g., starts with `http://` or `https://`) are sufficient for MVP .
-- **Secrets Management:**
-  - **Mandatory:** Store sensitive data (`EMAIL_USER`, `EMAIL_PASS`) only in the `.env` file.
-  - **Mandatory:** Ensure the `.env` file is included in `.gitignore` and is never committed to version control.
-  - Do not hardcode secrets anywhere in the source code.
-- **Dependency Security:** Periodically run `npm audit` to check for known vulnerabilities in dependencies. Consider enabling Dependabot if using GitHub.
-- **HTTP Client:** Use the native `Workspace` API as required ; avoid introducing less secure or overly complex HTTP client libraries.
-- **Scraping User-Agent:** Set a default User-Agent header in the scraper code (e.g., "BMadHackerDigest/0.1"). Allow overriding this default via the optional SCRAPER_USER_AGENT environment variable. 
-
-## Change Log
-
-| Change        | Date       | Version | Description                 | Author      |
-| ------------- | ---------- | ------- | --------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on Arch | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/combined-artifacts-for-posm.md

@@ -1,614 +0,0 @@
-# Epic 1 file
-
-# Epic 1: Project Initialization & Core Setup
-
-**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
-
-## Story List
-
-### Story 1.1: Initialize Project from Boilerplate
-
--   **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
--   **Detailed Requirements:**
-    -   Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
-    -   Initialize a git repository in the project root directory (if not already done by cloning).
-    -   Ensure the `.gitignore` file from the boilerplate is present.
-    -   Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
-    -   Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The project directory contains the files and structure from `bmad-boilerplate`.
-    -   AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
-    -   AC3: `npm run lint` command completes successfully without reporting any linting errors.
-    -   AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
-    -   AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
-    -   AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
-    -   AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
-
----
-
-### Story 1.2: Setup Environment Configuration
-
--   **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
--   **Detailed Requirements:**
-    -   Add a production dependency for loading `.env` files (e.g., `dotenv`). Run `npm install dotenv --save-prod` (or similar library).
-    -   Verify the `.env.example` file exists (from boilerplate).
-    -   Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
-    -   Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
-    -   Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
-    -   The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
-    -   Ensure the `.env` file is listed in `.gitignore` and is not committed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The chosen `.env` library (e.g., `dotenv`) is listed under `dependencies` in `package.json` and `package-lock.json` is updated.
-    -   AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
-    -   AC3: The `.env` file exists locally but is NOT tracked by git.
-    -   AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
-    -   AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
-
----
-
-### Story 1.3: Implement Basic CLI Entry Point & Execution
-
--   **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
--   **Detailed Requirements:**
-    -   Create the main application entry point file at `src/index.ts`.
-    -   Implement minimal code within `src/index.ts` to:
-        -   Import the configuration loading mechanism (from Story 1.2).
-        -   Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
-        -   (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
-    -   Confirm execution using boilerplate scripts.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `src/index.ts` file exists.
-    -   AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
-    -   AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
-    -   AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
-
----
-
-### Story 1.4: Setup Basic Logging and Output Directory
-
--   **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
--   **Detailed Requirements:**
-    -   Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
-    -   Refactor `src/index.ts` to use this `logger` for its startup message(s).
-    -   In `src/index.ts` (or a setup function called by it):
-        -   Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
-        -   Determine the current date in 'YYYY-MM-DD' format.
-        -   Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
-        -   Check if the base output directory exists; if not, create it.
-        -   Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
-        -   Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
--   **Acceptance Criteria (ACs):**
-    -   AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
-    -   AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
-    -   AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
-    -   AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
-    -   AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
-    -   AC6: The application exits gracefully after performing these setup steps (for now).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 1     | 2-pm           |
-
-# Epic 2 File
-
-# Epic 2: HN Data Acquisition & Persistence
-
-**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
-
-## Story List
-
-### Story 2.1: Implement Algolia HN API Client
-
--   **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
--   **Detailed Requirements:**
-    -   Create a new module: `src/clients/algoliaHNClient.ts`.
-    -   Implement an async function `WorkspaceTopStories` within the client:
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
-        -   Parse the JSON response.
-        -   Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
-        -   Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
-        -   Return an array of structured story objects.
-    -   Implement a separate async function `WorkspaceCommentsForStory` within the client:
-        -   Accept `storyId` and `maxComments` limit as arguments.
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
-        -   Parse the JSON response.
-        -   Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
-        -   Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
-        -   Return an array of structured comment objects.
-    -   Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
-    -   Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
-    -   AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
-    -   AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
-    -   AC4: Both functions use the native `Workspace` API internally.
-    -   AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
-    -   AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
-
----
-
-### Story 2.2: Integrate HN Data Fetching into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts` (or a main async function called by it).
-    -   Import the `algoliaHNClient` functions.
-    -   Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
-    -   After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
-    -   Log the number of stories fetched.
-    -   Iterate through the array of fetched `Story` objects.
-    -   For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
-    -   Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
-    -   Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
-    -   AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
-    -   AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
-    -   AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
-
----
-
-### Story 2.3: Persist Fetched HN Data Locally
-
--   **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
--   **Detailed Requirements:**
-    -   Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
-    -   Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
-    -   In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
-        -   Get the full path to the date-stamped output directory (determined in Epic 1).
-        -   Construct the filename for the story's data: `{storyId}_data.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
-        -   Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
-    -   Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
-    -   AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
-    -   AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
-    -   AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
-
----
-
-### Story 2.4: Implement Stage Testing Utility for HN Fetching
-
--   **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
-    -   This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
-    -   The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
-    -   The script should log its progress using the logger utility.
-    -   Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/fetch_hn_data.ts` exists.
-    -   AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
-    -   AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
-    -   AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
-    -   AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 2     | 2-pm           |
-
-# Epic 3 File
-
-# Epic 3: Article Scraping & Persistence
-
-**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
-
-## Story List
-
-### Story 3.1: Implement Basic Article Scraper Module
-
--   **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
--   **Detailed Requirements:**
-    -   Create a new module: `src/scraper/articleScraper.ts`.
-    -   Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
-    -   Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
-    -   Inside the function:
-        -   Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
-        -   Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
-        -   Check the `response.ok` status. If not okay, log error and return `null`.
-        -   Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
-        -   If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
-        -   Wrap the extraction logic in a `try...catch` to handle library-specific errors.
-        -   Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
-        -   Return `null` if extraction fails or results in empty content.
-    -   Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
-    -   Define TypeScript types/interfaces as needed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
-    -   AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
-    -   AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
-    -   AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
-    -   AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
-    -   AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
-    -   AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
-
----
-
-### Story 3.2: Integrate Article Scraping into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
-    -   Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
-        -   Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
-        -   If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
-        -   If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
-        -   Call `await scrapeArticle(story.url)`.
-        -   Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
-        -   Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
-    -   AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
-    -   AC3: For stories with valid URLs, the `scrapeArticle` function is called.
-    -   AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
-    -   AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
-
----
-
-### Story 3.3: Persist Scraped Article Text Locally
-
--   **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
--   **Detailed Requirements:**
-    -   Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
-    -   In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
-        -   Retrieve the full path to the current date-stamped output directory.
-        -   Construct the filename: `{storyId}_article.txt`.
-        -   Construct the full file path using `path.join()`.
-        -   Get the successfully scraped article text string (`articleContent`).
-        -   Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
-        -   Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
-    -   Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
-    -   AC2: The name of each article text file is `{storyId}_article.txt`.
-    -   AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
-    -   AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
-    -   AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
-
----
-
-### Story 3.4: Implement Stage Testing Utility for Scraping
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/scrape_articles.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
-    -   The script should:
-        -   Initialize the logger.
-        -   Load configuration (to get `OUTPUT_DIR_PATH`).
-        -   Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
-        -   Read the directory contents and identify all `{storyId}_data.json` files.
-        -   For each `_data.json` file found:
-            -   Read and parse the JSON content.
-            -   Extract the `storyId` and `url`.
-            -   If a valid `url` exists, call `await scrapeArticle(url)`.
-            -   If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
-            -   Log the progress and outcome (skip/success/fail) for each story processed.
-    -   Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/scrape_articles.ts` exists.
-    -   AC2: The script `stage:scrape` is defined in `package.json`.
-    -   AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
-    -   AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
-    -   AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
-    -   AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
-    -   AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 3     | 2-pm           |
-
-# Epic 4 File
-
-# Epic 4: LLM Summarization & Persistence
-
-**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
-
-## Story List
-
-### Story 4.1: Implement Ollama Client Module
-
--   **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
--   **Detailed Requirements:**
-    -   **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
-    -   Create a new module: `src/clients/ollamaClient.ts`.
-    -   Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
-    -   Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
-    -   Inside `generateSummary`:
-        -   Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
-        -   Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
-        -   Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
-        -   Handle `Workspace` errors (network, timeout) using `try...catch`.
-        -   Check `response.ok`. If not OK, log the status/error and return `null`.
-        -   Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
-        -   Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
-        -   Return the extracted summary string on success. Return `null` on any failure.
-        -   Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
-    -   Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
-    -   AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
-    -   AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
-    -   AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
-    -   AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
-    * AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
-    * AC7: Logs provide visibility into the client's interaction with the Ollama API.
-
----
-
-### Story 4.2: Define Summarization Prompts
-
-* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
-* **Detailed Requirements:**
-    * Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
-    * Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
-
----
-
-### Story 4.3: Integrate Summarization into Main Workflow
-
-* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
-* **Detailed Requirements:**
-    * Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
-    * Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
-    * Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
-    * Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
-    * **Article Summary Generation:**
-        * Check if the `story` object has non-null `articleContent`.
-        * If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
-        * If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
-    * **Discussion Summary Generation:**
-        * Check if the `story` object has a non-empty `comments` array.
-        * If yes:
-            * Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
-            * **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
-            * Log "Attempting discussion summarization for story {storyId}".
-            * Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
-            * Store the result (string or null) as `story.discussionSummary`. Log success/failure.
-        * If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
-* **Acceptance Criteria (ACs):**
-    * AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
-    * AC2: Article summary is attempted only if `articleContent` exists for a story.
-    * AC3: Discussion summary is attempted only if `comments` exist for a story.
-    * AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
-    * AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
-    * AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
-
----
-
-### Story 4.4: Persist Generated Summaries Locally
-
-*(No changes needed for this story based on recent decisions)*
-
--   **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
--   **Detailed Requirements:**
-    -   Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
-    -   Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
-    -   In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
-        -   Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
-        -   Get the full path to the date-stamped output directory.
-        -   Construct the filename: `{storyId}_summary.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
-        -   Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
-        -   Log the successful saving of the summary file or any file writing errors.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
-    -   AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
-    -   AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC5: A valid ISO timestamp is present in the `summarizedAt` field.
-    -   AC6: Logs confirm successful writing of each summary file or report file system errors.
-
----
-
-### Story 4.5: Implement Stage Testing Utility for Summarization
-
-*(Changes needed to reflect prompt sourcing and optional truncation)*
-
-* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
-* **Detailed Requirements:**
-    * Create a new standalone script file: `src/stages/summarize_content.ts`.
-    * Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
-    * The script should:
-        * Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
-        * Determine target date-stamped directory path.
-        * Find all `{storyId}_data.json` files in the directory.
-        * For each `storyId` found:
-            * Read `{storyId}_data.json` to get comments. Format them into a single text block.
-            * *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
-            * Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
-            * **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
-            * Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
-            * Construct the summary result object (with summaries or nulls, and timestamp).
-            * Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
-            * Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
-    * Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The file `src/stages/summarize_content.ts` exists.
-    * AC2: The script `stage:summarize` is defined in `package.json`.
-    * AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
-    * AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
-    * AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
-    * AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
-    * AC8: The script does not call Algolia API or the article scraper module.
-
-## Change Log
-
-| Change                      | Date         | Version | Description                          | Author         |
-| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
-| Integrate prompts.md refs   | 2025-05-04   | 0.3     | Updated stories 4.2, 4.3, 4.5        | 3-Architect    |
-| Added Ollama Prereq Note    | 2025-05-04   | 0.2     | Added note about local Ollama setup  | 2-pm           |
-| Initial Draft               | 2025-05-04   | 0.1     | First draft of Epic 4                | 2-pm           |
-
-# Epic 5 File
-
-# Epic 5: Digest Assembly & Email Dispatch
-
-**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
-
-## Story List
-
-### Story 5.1: Implement Email Content Assembler
-
--   **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
--   **Detailed Requirements:**
-    -   Create a new module: `src/email/contentAssembler.ts`.
-    -   Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
-    -   Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
-    -   The function should:
-        -   Use Node.js `fs` to read the contents of the `dateDirPath`.
-        -   Identify all files matching the pattern `{storyId}_data.json`.
-        -   For each `storyId` found:
-            -   Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
-            -   Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
-            -   Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
-        -   Collect all successfully constructed `DigestData` objects into an array.
-        -   Return the array. It should ideally contain 10 items if all previous stages succeeded.
-    -   Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
-    -   AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
-    -   AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
-    -   AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
-    -   AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
-
----
-
-### Story 5.2: Create HTML Email Template & Renderer
-
--   **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
--   **Detailed Requirements:**
-    -   Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
-    -   Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
-    -   The function should generate an HTML string with:
-        -   A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
-        -   A loop through the `data` array.
-        -   For each `story` in `data`:
-            -   Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
-            -   Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
-            -   Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
-            -   Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
-            -   Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
-    -   Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
-    -   Return the complete HTML document as a string.
--   **Acceptance Criteria (ACs):**
-    -   AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
-    -   AC2: The function returns a single, complete HTML string.
-    -   AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
-    -   AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
-    -   AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
-
----
-
-### Story 5.3: Implement Nodemailer Email Sender
-
--   **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
--   **Detailed Requirements:**
-    -   Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
-    -   Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
-    -   Create a new module: `src/email/emailSender.ts`.
-    -   Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
-    -   Inside the function:
-        -   Load the `EMAIL_*` variables from the config module.
-        -   Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
-        -   Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
-        -   Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
-        -   Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
-        -   Call `await transporter.sendMail(mailOptions)`.
-        -   If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
-        -   If `sendMail` fails (throws error), log the error using the logger. Return `false`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
-    -   AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
-    -   AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
-    -   AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
-    -   AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
-    -   AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
-    -   AC7: Email sending success (including message ID) or failure is logged clearly.
-    -   AC8: The function returns `true` on successful sending, `false` otherwise.
-
----
-
-### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
-
--   **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
-    -   Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
-        -   Log "Starting final digest assembly and email dispatch...".
-        -   Determine the path to the current date-stamped output directory.
-        -   Call `const digestData = await assembleDigestData(dateDirPath)`.
-        -   Check if `digestData` array is not empty.
-            -   If yes:
-                -   Get the current date string (e.g., 'YYYY-MM-DD').
-                -   `const htmlContent = renderDigestHtml(digestData, currentDate)`.
-                -   `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
-                -   `const emailSent = await sendDigestEmail(subject, htmlContent)`.
-                -   Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
-            -   If no (`digestData` is empty or assembly failed):
-                -   Log an error: "Failed to assemble digest data or no data found. Skipping email."
-        -   Log "BMad Hacker Daily Digest process finished."
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
-    -   AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
-    -   AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
-    -   AC4: The final success or failure of the email sending step is logged.
-    -   AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
-    -   AC6: The application logs a final completion message.
-
----
-
-### Story 5.5: Implement Stage Testing Utility for Emailing
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
--   **Detailed Requirements:**
-    -   Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
-    -   Create a new standalone script file: `src/stages/send_digest.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
-    -   Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
-    -   The script should:
-        -   Initialize logger, load config.
-        -   Determine the target date-stamped directory path (from arg or default). Log the target directory.
-        -   Call `await assembleDigestData(dateDirPath)`.
-        -   If data is assembled and not empty:
-            -   Determine the date string for the subject/title.
-            -   Call `renderDigestHtml(digestData, dateString)` to get HTML.
-            -   Construct the subject string.
-            -   Check the `dryRun` flag:
-                -   If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
-                -   If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
-        -   If data assembly fails or is empty, log the error.
-    -   Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
-    -   AC2: The script `stage:email` is defined in `package.json` allowing arguments.
-    -   AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
-    -   AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
-    -   AC5: The script correctly identifies and acts upon the `--dry-run` flag.
-    -   AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
-    -   AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 5     | 2-pm           |
-
-# END EPIC FILES

V2-FULL-DEMO-WALKTHROUGH/combined-artifacts-for-posm.txt

@@ -1,614 +0,0 @@
-# Epic 1 file
-
-# Epic 1: Project Initialization & Core Setup
-
-**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
-
-## Story List
-
-### Story 1.1: Initialize Project from Boilerplate
-
--   **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
--   **Detailed Requirements:**
-    -   Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
-    -   Initialize a git repository in the project root directory (if not already done by cloning).
-    -   Ensure the `.gitignore` file from the boilerplate is present.
-    -   Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
-    -   Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The project directory contains the files and structure from `bmad-boilerplate`.
-    -   AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
-    -   AC3: `npm run lint` command completes successfully without reporting any linting errors.
-    -   AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
-    -   AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
-    -   AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
-    -   AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
-
----
-
-### Story 1.2: Setup Environment Configuration
-
--   **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
--   **Detailed Requirements:**
-    -   Add a production dependency for loading `.env` files (e.g., `dotenv`). Run `npm install dotenv --save-prod` (or similar library).
-    -   Verify the `.env.example` file exists (from boilerplate).
-    -   Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
-    -   Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
-    -   Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
-    -   The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
-    -   Ensure the `.env` file is listed in `.gitignore` and is not committed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The chosen `.env` library (e.g., `dotenv`) is listed under `dependencies` in `package.json` and `package-lock.json` is updated.
-    -   AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
-    -   AC3: The `.env` file exists locally but is NOT tracked by git.
-    -   AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
-    -   AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
-
----
-
-### Story 1.3: Implement Basic CLI Entry Point & Execution
-
--   **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
--   **Detailed Requirements:**
-    -   Create the main application entry point file at `src/index.ts`.
-    -   Implement minimal code within `src/index.ts` to:
-        -   Import the configuration loading mechanism (from Story 1.2).
-        -   Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
-        -   (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
-    -   Confirm execution using boilerplate scripts.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `src/index.ts` file exists.
-    -   AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
-    -   AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
-    -   AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
-
----
-
-### Story 1.4: Setup Basic Logging and Output Directory
-
--   **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
--   **Detailed Requirements:**
-    -   Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
-    -   Refactor `src/index.ts` to use this `logger` for its startup message(s).
-    -   In `src/index.ts` (or a setup function called by it):
-        -   Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
-        -   Determine the current date in 'YYYY-MM-DD' format.
-        -   Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
-        -   Check if the base output directory exists; if not, create it.
-        -   Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
-        -   Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
--   **Acceptance Criteria (ACs):**
-    -   AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
-    -   AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
-    -   AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
-    -   AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
-    -   AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
-    -   AC6: The application exits gracefully after performing these setup steps (for now).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 1     | 2-pm           |
-
-# Epic 2 File
-
-# Epic 2: HN Data Acquisition & Persistence
-
-**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
-
-## Story List
-
-### Story 2.1: Implement Algolia HN API Client
-
--   **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
--   **Detailed Requirements:**
-    -   Create a new module: `src/clients/algoliaHNClient.ts`.
-    -   Implement an async function `WorkspaceTopStories` within the client:
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
-        -   Parse the JSON response.
-        -   Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
-        -   Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
-        -   Return an array of structured story objects.
-    -   Implement a separate async function `WorkspaceCommentsForStory` within the client:
-        -   Accept `storyId` and `maxComments` limit as arguments.
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
-        -   Parse the JSON response.
-        -   Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
-        -   Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
-        -   Return an array of structured comment objects.
-    -   Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
-    -   Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
-    -   AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
-    -   AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
-    -   AC4: Both functions use the native `Workspace` API internally.
-    -   AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
-    -   AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
-
----
-
-### Story 2.2: Integrate HN Data Fetching into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts` (or a main async function called by it).
-    -   Import the `algoliaHNClient` functions.
-    -   Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
-    -   After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
-    -   Log the number of stories fetched.
-    -   Iterate through the array of fetched `Story` objects.
-    -   For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
-    -   Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
-    -   Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
-    -   AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
-    -   AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
-    -   AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
-
----
-
-### Story 2.3: Persist Fetched HN Data Locally
-
--   **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
--   **Detailed Requirements:**
-    -   Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
-    -   Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
-    -   In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
-        -   Get the full path to the date-stamped output directory (determined in Epic 1).
-        -   Construct the filename for the story's data: `{storyId}_data.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
-        -   Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
-    -   Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
-    -   AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
-    -   AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
-    -   AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
-
----
-
-### Story 2.4: Implement Stage Testing Utility for HN Fetching
-
--   **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
-    -   This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
-    -   The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
-    -   The script should log its progress using the logger utility.
-    -   Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/fetch_hn_data.ts` exists.
-    -   AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
-    -   AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
-    -   AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
-    -   AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 2     | 2-pm           |
-
-# Epic 3 File
-
-# Epic 3: Article Scraping & Persistence
-
-**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
-
-## Story List
-
-### Story 3.1: Implement Basic Article Scraper Module
-
--   **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
--   **Detailed Requirements:**
-    -   Create a new module: `src/scraper/articleScraper.ts`.
-    -   Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
-    -   Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
-    -   Inside the function:
-        -   Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
-        -   Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
-        -   Check the `response.ok` status. If not okay, log error and return `null`.
-        -   Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
-        -   If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
-        -   Wrap the extraction logic in a `try...catch` to handle library-specific errors.
-        -   Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
-        -   Return `null` if extraction fails or results in empty content.
-    -   Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
-    -   Define TypeScript types/interfaces as needed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
-    -   AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
-    -   AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
-    -   AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
-    -   AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
-    -   AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
-    -   AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
-
----
-
-### Story 3.2: Integrate Article Scraping into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
-    -   Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
-        -   Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
-        -   If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
-        -   If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
-        -   Call `await scrapeArticle(story.url)`.
-        -   Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
-        -   Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
-    -   AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
-    -   AC3: For stories with valid URLs, the `scrapeArticle` function is called.
-    -   AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
-    -   AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
-
----
-
-### Story 3.3: Persist Scraped Article Text Locally
-
--   **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
--   **Detailed Requirements:**
-    -   Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
-    -   In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
-        -   Retrieve the full path to the current date-stamped output directory.
-        -   Construct the filename: `{storyId}_article.txt`.
-        -   Construct the full file path using `path.join()`.
-        -   Get the successfully scraped article text string (`articleContent`).
-        -   Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
-        -   Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
-    -   Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
-    -   AC2: The name of each article text file is `{storyId}_article.txt`.
-    -   AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
-    -   AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
-    -   AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
-
----
-
-### Story 3.4: Implement Stage Testing Utility for Scraping
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/scrape_articles.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
-    -   The script should:
-        -   Initialize the logger.
-        -   Load configuration (to get `OUTPUT_DIR_PATH`).
-        -   Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
-        -   Read the directory contents and identify all `{storyId}_data.json` files.
-        -   For each `_data.json` file found:
-            -   Read and parse the JSON content.
-            -   Extract the `storyId` and `url`.
-            -   If a valid `url` exists, call `await scrapeArticle(url)`.
-            -   If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
-            -   Log the progress and outcome (skip/success/fail) for each story processed.
-    -   Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/scrape_articles.ts` exists.
-    -   AC2: The script `stage:scrape` is defined in `package.json`.
-    -   AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
-    -   AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
-    -   AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
-    -   AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
-    -   AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 3     | 2-pm           |
-
-# Epic 4 File
-
-# Epic 4: LLM Summarization & Persistence
-
-**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
-
-## Story List
-
-### Story 4.1: Implement Ollama Client Module
-
--   **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
--   **Detailed Requirements:**
-    -   **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
-    -   Create a new module: `src/clients/ollamaClient.ts`.
-    -   Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
-    -   Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
-    -   Inside `generateSummary`:
-        -   Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
-        -   Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
-        -   Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
-        -   Handle `Workspace` errors (network, timeout) using `try...catch`.
-        -   Check `response.ok`. If not OK, log the status/error and return `null`.
-        -   Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
-        -   Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
-        -   Return the extracted summary string on success. Return `null` on any failure.
-        -   Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
-    -   Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
-    -   AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
-    -   AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
-    -   AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
-    -   AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
-    * AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
-    * AC7: Logs provide visibility into the client's interaction with the Ollama API.
-
----
-
-### Story 4.2: Define Summarization Prompts
-
-* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
-* **Detailed Requirements:**
-    * Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
-    * Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
-
----
-
-### Story 4.3: Integrate Summarization into Main Workflow
-
-* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
-* **Detailed Requirements:**
-    * Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
-    * Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
-    * Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
-    * Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
-    * **Article Summary Generation:**
-        * Check if the `story` object has non-null `articleContent`.
-        * If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
-        * If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
-    * **Discussion Summary Generation:**
-        * Check if the `story` object has a non-empty `comments` array.
-        * If yes:
-            * Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
-            * **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
-            * Log "Attempting discussion summarization for story {storyId}".
-            * Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
-            * Store the result (string or null) as `story.discussionSummary`. Log success/failure.
-        * If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
-* **Acceptance Criteria (ACs):**
-    * AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
-    * AC2: Article summary is attempted only if `articleContent` exists for a story.
-    * AC3: Discussion summary is attempted only if `comments` exist for a story.
-    * AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
-    * AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
-    * AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
-
----
-
-### Story 4.4: Persist Generated Summaries Locally
-
-*(No changes needed for this story based on recent decisions)*
-
--   **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
--   **Detailed Requirements:**
-    -   Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
-    -   Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
-    -   In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
-        -   Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
-        -   Get the full path to the date-stamped output directory.
-        -   Construct the filename: `{storyId}_summary.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
-        -   Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
-        -   Log the successful saving of the summary file or any file writing errors.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
-    -   AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
-    -   AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC5: A valid ISO timestamp is present in the `summarizedAt` field.
-    -   AC6: Logs confirm successful writing of each summary file or report file system errors.
-
----
-
-### Story 4.5: Implement Stage Testing Utility for Summarization
-
-*(Changes needed to reflect prompt sourcing and optional truncation)*
-
-* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
-* **Detailed Requirements:**
-    * Create a new standalone script file: `src/stages/summarize_content.ts`.
-    * Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
-    * The script should:
-        * Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
-        * Determine target date-stamped directory path.
-        * Find all `{storyId}_data.json` files in the directory.
-        * For each `storyId` found:
-            * Read `{storyId}_data.json` to get comments. Format them into a single text block.
-            * *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
-            * Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
-            * **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
-            * Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
-            * Construct the summary result object (with summaries or nulls, and timestamp).
-            * Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
-            * Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
-    * Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The file `src/stages/summarize_content.ts` exists.
-    * AC2: The script `stage:summarize` is defined in `package.json`.
-    * AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
-    * AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
-    * AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
-    * AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
-    * AC8: The script does not call Algolia API or the article scraper module.
-
-## Change Log
-
-| Change                      | Date         | Version | Description                          | Author         |
-| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
-| Integrate prompts.md refs   | 2025-05-04   | 0.3     | Updated stories 4.2, 4.3, 4.5        | 3-Architect    |
-| Added Ollama Prereq Note    | 2025-05-04   | 0.2     | Added note about local Ollama setup  | 2-pm           |
-| Initial Draft               | 2025-05-04   | 0.1     | First draft of Epic 4                | 2-pm           |
-
-# Epic 5 File
-
-# Epic 5: Digest Assembly & Email Dispatch
-
-**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
-
-## Story List
-
-### Story 5.1: Implement Email Content Assembler
-
--   **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
--   **Detailed Requirements:**
-    -   Create a new module: `src/email/contentAssembler.ts`.
-    -   Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
-    -   Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
-    -   The function should:
-        -   Use Node.js `fs` to read the contents of the `dateDirPath`.
-        -   Identify all files matching the pattern `{storyId}_data.json`.
-        -   For each `storyId` found:
-            -   Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
-            -   Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
-            -   Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
-        -   Collect all successfully constructed `DigestData` objects into an array.
-        -   Return the array. It should ideally contain 10 items if all previous stages succeeded.
-    -   Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
-    -   AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
-    -   AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
-    -   AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
-    -   AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
-
----
-
-### Story 5.2: Create HTML Email Template & Renderer
-
--   **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
--   **Detailed Requirements:**
-    -   Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
-    -   Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
-    -   The function should generate an HTML string with:
-        -   A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
-        -   A loop through the `data` array.
-        -   For each `story` in `data`:
-            -   Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
-            -   Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
-            -   Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
-            -   Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
-            -   Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
-    -   Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
-    -   Return the complete HTML document as a string.
--   **Acceptance Criteria (ACs):**
-    -   AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
-    -   AC2: The function returns a single, complete HTML string.
-    -   AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
-    -   AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
-    -   AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
-
----
-
-### Story 5.3: Implement Nodemailer Email Sender
-
--   **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
--   **Detailed Requirements:**
-    -   Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
-    -   Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
-    -   Create a new module: `src/email/emailSender.ts`.
-    -   Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
-    -   Inside the function:
-        -   Load the `EMAIL_*` variables from the config module.
-        -   Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
-        -   Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
-        -   Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
-        -   Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
-        -   Call `await transporter.sendMail(mailOptions)`.
-        -   If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
-        -   If `sendMail` fails (throws error), log the error using the logger. Return `false`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
-    -   AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
-    -   AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
-    -   AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
-    -   AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
-    -   AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
-    -   AC7: Email sending success (including message ID) or failure is logged clearly.
-    -   AC8: The function returns `true` on successful sending, `false` otherwise.
-
----
-
-### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
-
--   **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
-    -   Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
-        -   Log "Starting final digest assembly and email dispatch...".
-        -   Determine the path to the current date-stamped output directory.
-        -   Call `const digestData = await assembleDigestData(dateDirPath)`.
-        -   Check if `digestData` array is not empty.
-            -   If yes:
-                -   Get the current date string (e.g., 'YYYY-MM-DD').
-                -   `const htmlContent = renderDigestHtml(digestData, currentDate)`.
-                -   `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
-                -   `const emailSent = await sendDigestEmail(subject, htmlContent)`.
-                -   Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
-            -   If no (`digestData` is empty or assembly failed):
-                -   Log an error: "Failed to assemble digest data or no data found. Skipping email."
-        -   Log "BMad Hacker Daily Digest process finished."
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
-    -   AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
-    -   AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
-    -   AC4: The final success or failure of the email sending step is logged.
-    -   AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
-    -   AC6: The application logs a final completion message.
-
----
-
-### Story 5.5: Implement Stage Testing Utility for Emailing
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
--   **Detailed Requirements:**
-    -   Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
-    -   Create a new standalone script file: `src/stages/send_digest.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
-    -   Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
-    -   The script should:
-        -   Initialize logger, load config.
-        -   Determine the target date-stamped directory path (from arg or default). Log the target directory.
-        -   Call `await assembleDigestData(dateDirPath)`.
-        -   If data is assembled and not empty:
-            -   Determine the date string for the subject/title.
-            -   Call `renderDigestHtml(digestData, dateString)` to get HTML.
-            -   Construct the subject string.
-            -   Check the `dryRun` flag:
-                -   If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
-                -   If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
-        -   If data assembly fails or is empty, log the error.
-    -   Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
-    -   AC2: The script `stage:email` is defined in `package.json` allowing arguments.
-    -   AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
-    -   AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
-    -   AC5: The script correctly identifies and acts upon the `--dry-run` flag.
-    -   AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
-    -   AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 5     | 2-pm           |
-
-# END EPIC FILES

V2-FULL-DEMO-WALKTHROUGH/data-models.md

@@ -1,202 +0,0 @@
-# BMad Hacker Daily Digest Data Models
-
-This document defines the core data structures used within the application, the format of persisted data files, and relevant API payload schemas. These types would typically reside in `src/types/`.
-
-## 1. Core Application Entities / Domain Objects (In-Memory)
-
-These TypeScript interfaces represent the main data objects manipulated during the pipeline execution.
-
-### `Comment`
-
-- **Description:** Represents a single Hacker News comment fetched from the Algolia API.
-- **Schema / Interface Definition (`src/types/hn.ts`):**
-  ```typescript
-  export interface Comment {
-    commentId: string; // Unique identifier (from Algolia objectID)
-    commentText: string | null; // Text content of the comment (nullable from API)
-    author: string | null; // Author's HN username (nullable from API)
-    createdAt: string; // ISO 8601 timestamp string of comment creation
-  }
-  ```
-
-### `Story`
-
-- **Description:** Represents a Hacker News story, initially fetched from Algolia and progressively augmented with comments, scraped content, and summaries during pipeline execution.
-- **Schema / Interface Definition (`src/types/hn.ts`):**
-
-  ```typescript
-  import { Comment } from "./hn";
-
-  export interface Story {
-    storyId: string; // Unique identifier (from Algolia objectID)
-    title: string; // Story title
-    articleUrl: string | null; // URL of the linked article (can be null from API)
-    hnUrl: string; // URL to the HN discussion page (constructed)
-    points?: number; // HN points (optional)
-    numComments?: number; // Number of comments reported by API (optional)
-
-    // Data added during pipeline execution
-    comments: Comment[]; // Fetched comments [Added in Epic 2]
-    articleContent: string | null; // Scraped article text [Added in Epic 3]
-    articleSummary: string | null; // Generated article summary [Added in Epic 4]
-    discussionSummary: string | null; // Generated discussion summary [Added in Epic 4]
-    fetchedAt: string; // ISO 8601 timestamp when story/comments were fetched [Added in Epic 2]
-    summarizedAt?: string; // ISO 8601 timestamp when summaries were generated [Added in Epic 4]
-  }
-  ```
-
-### `DigestData`
-
-- **Description:** Represents the consolidated data needed for a single story when assembling the final email digest. Created by reading persisted files.
-- **Schema / Interface Definition (`src/types/email.ts`):**
-  ```typescript
-  export interface DigestData {
-    storyId: string;
-    title: string;
-    hnUrl: string;
-    articleUrl: string | null;
-    articleSummary: string | null;
-    discussionSummary: string | null;
-  }
-  ```
-
-## 2. API Payload Schemas
-
-These describe the relevant parts of request/response payloads for external APIs.
-
-### Algolia HN API - Story Response Subset
-
-- **Description:** Relevant fields extracted from the Algolia HN Search API response for front-page stories.
-- **Schema (Conceptual JSON):**
-  ```json
-  {
-    "hits": [
-      {
-        "objectID": "string", // Used as storyId
-        "title": "string",
-        "url": "string | null", // Used as articleUrl
-        "points": "number",
-        "num_comments": "number"
-        // ... other fields ignored
-      }
-      // ... more hits (stories)
-    ]
-    // ... other top-level fields ignored
-  }
-  ```
-
-### Algolia HN API - Comment Response Subset
-
-- **Description:** Relevant fields extracted from the Algolia HN Search API response for comments associated with a story.
-- **Schema (Conceptual JSON):**
-  ```json
-  {
-    "hits": [
-      {
-        "objectID": "string", // Used as commentId
-        "comment_text": "string | null",
-        "author": "string | null",
-        "created_at": "string" // ISO 8601 format
-        // ... other fields ignored
-      }
-      // ... more hits (comments)
-    ]
-    // ... other top-level fields ignored
-  }
-  ```
-
-### Ollama `/api/generate` Request
-
-- **Description:** Payload sent to the local Ollama instance to generate a summary.
-- **Schema (`src/types/ollama.ts` or inline):**
-  ```typescript
-  export interface OllamaGenerateRequest {
-    model: string; // e.g., "llama3" (from config)
-    prompt: string; // The full prompt including context
-    stream: false; // Required to be false for single response
-    // system?: string; // Optional system prompt (if used)
-    // options?: Record<string, any>; // Optional generation parameters
-  }
-  ```
-
-### Ollama `/api/generate` Response
-
-- **Description:** Relevant fields expected from the Ollama API response when `stream: false`.
-- **Schema (`src/types/ollama.ts` or inline):**
-  ```typescript
-  export interface OllamaGenerateResponse {
-    model: string;
-    created_at: string; // ISO 8601 timestamp
-    response: string; // The generated summary text
-    done: boolean; // Should be true if stream=false and generation succeeded
-    // Optional fields detailing context, timings, etc. are ignored for MVP
-    // total_duration?: number;
-    // load_duration?: number;
-    // prompt_eval_count?: number;
-    // prompt_eval_duration?: number;
-    // eval_count?: number;
-    // eval_duration?: number;
-  }
-  ```
-  _(Note: Error responses might have a different structure, e.g., `{ "error": "message" }`)_
-
-## 3. Database Schemas
-
-- **N/A:** This application does not use a database for MVP; data is persisted to the local filesystem.
-
-## 4. State File Schemas (Local Filesystem Persistence)
-
-These describe the format of files saved in the `output/YYYY-MM-DD/` directory.
-
-### `{storyId}_data.json`
-
-- **Purpose:** Stores fetched story metadata and associated comments.
-- **Format:** JSON
-- **Schema Definition (Matches `Story` type fields relevant at time of saving):**
-  ```json
-  {
-    "storyId": "string",
-    "title": "string",
-    "articleUrl": "string | null",
-    "hnUrl": "string",
-    "points": "number | undefined",
-    "numComments": "number | undefined",
-    "fetchedAt": "string", // ISO 8601 timestamp
-    "comments": [
-      // Array of Comment objects
-      {
-        "commentId": "string",
-        "commentText": "string | null",
-        "author": "string | null",
-        "createdAt": "string" // ISO 8601 timestamp
-      }
-      // ... more comments
-    ]
-  }
-  ```
-
-### `{storyId}_article.txt`
-
-- **Purpose:** Stores the successfully scraped plain text content of the linked article.
-- **Format:** Plain Text (`.txt`)
-- **Schema Definition:** N/A (Content is the raw extracted string). File only exists if scraping was successful.
-
-### `{storyId}_summary.json`
-
-- **Purpose:** Stores the generated article and discussion summaries.
-- **Format:** JSON
-- **Schema Definition:**
-  ```json
-  {
-    "storyId": "string",
-    "articleSummary": "string | null", // Null if scraping failed or summarization failed
-    "discussionSummary": "string | null", // Null if no comments or summarization failed
-    "summarizedAt": "string" // ISO 8601 timestamp
-  }
-  ```
-
-## Change Log
-
-| Change        | Date       | Version | Description                  | Author      |
-| ------------- | ---------- | ------- | ---------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on Epics | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/data-models.txt

@@ -1,202 +0,0 @@
-# BMad Hacker Daily Digest Data Models
-
-This document defines the core data structures used within the application, the format of persisted data files, and relevant API payload schemas. These types would typically reside in `src/types/`.
-
-## 1. Core Application Entities / Domain Objects (In-Memory)
-
-These TypeScript interfaces represent the main data objects manipulated during the pipeline execution.
-
-### `Comment`
-
-- **Description:** Represents a single Hacker News comment fetched from the Algolia API.
-- **Schema / Interface Definition (`src/types/hn.ts`):**
-  ```typescript
-  export interface Comment {
-    commentId: string; // Unique identifier (from Algolia objectID)
-    commentText: string | null; // Text content of the comment (nullable from API)
-    author: string | null; // Author's HN username (nullable from API)
-    createdAt: string; // ISO 8601 timestamp string of comment creation
-  }
-  ```
-
-### `Story`
-
-- **Description:** Represents a Hacker News story, initially fetched from Algolia and progressively augmented with comments, scraped content, and summaries during pipeline execution.
-- **Schema / Interface Definition (`src/types/hn.ts`):**
-
-  ```typescript
-  import { Comment } from "./hn";
-
-  export interface Story {
-    storyId: string; // Unique identifier (from Algolia objectID)
-    title: string; // Story title
-    articleUrl: string | null; // URL of the linked article (can be null from API)
-    hnUrl: string; // URL to the HN discussion page (constructed)
-    points?: number; // HN points (optional)
-    numComments?: number; // Number of comments reported by API (optional)
-
-    // Data added during pipeline execution
-    comments: Comment[]; // Fetched comments [Added in Epic 2]
-    articleContent: string | null; // Scraped article text [Added in Epic 3]
-    articleSummary: string | null; // Generated article summary [Added in Epic 4]
-    discussionSummary: string | null; // Generated discussion summary [Added in Epic 4]
-    fetchedAt: string; // ISO 8601 timestamp when story/comments were fetched [Added in Epic 2]
-    summarizedAt?: string; // ISO 8601 timestamp when summaries were generated [Added in Epic 4]
-  }
-  ```
-
-### `DigestData`
-
-- **Description:** Represents the consolidated data needed for a single story when assembling the final email digest. Created by reading persisted files.
-- **Schema / Interface Definition (`src/types/email.ts`):**
-  ```typescript
-  export interface DigestData {
-    storyId: string;
-    title: string;
-    hnUrl: string;
-    articleUrl: string | null;
-    articleSummary: string | null;
-    discussionSummary: string | null;
-  }
-  ```
-
-## 2. API Payload Schemas
-
-These describe the relevant parts of request/response payloads for external APIs.
-
-### Algolia HN API - Story Response Subset
-
-- **Description:** Relevant fields extracted from the Algolia HN Search API response for front-page stories.
-- **Schema (Conceptual JSON):**
-  ```json
-  {
-    "hits": [
-      {
-        "objectID": "string", // Used as storyId
-        "title": "string",
-        "url": "string | null", // Used as articleUrl
-        "points": "number",
-        "num_comments": "number"
-        // ... other fields ignored
-      }
-      // ... more hits (stories)
-    ]
-    // ... other top-level fields ignored
-  }
-  ```
-
-### Algolia HN API - Comment Response Subset
-
-- **Description:** Relevant fields extracted from the Algolia HN Search API response for comments associated with a story.
-- **Schema (Conceptual JSON):**
-  ```json
-  {
-    "hits": [
-      {
-        "objectID": "string", // Used as commentId
-        "comment_text": "string | null",
-        "author": "string | null",
-        "created_at": "string" // ISO 8601 format
-        // ... other fields ignored
-      }
-      // ... more hits (comments)
-    ]
-    // ... other top-level fields ignored
-  }
-  ```
-
-### Ollama `/api/generate` Request
-
-- **Description:** Payload sent to the local Ollama instance to generate a summary.
-- **Schema (`src/types/ollama.ts` or inline):**
-  ```typescript
-  export interface OllamaGenerateRequest {
-    model: string; // e.g., "llama3" (from config)
-    prompt: string; // The full prompt including context
-    stream: false; // Required to be false for single response
-    // system?: string; // Optional system prompt (if used)
-    // options?: Record<string, any>; // Optional generation parameters
-  }
-  ```
-
-### Ollama `/api/generate` Response
-
-- **Description:** Relevant fields expected from the Ollama API response when `stream: false`.
-- **Schema (`src/types/ollama.ts` or inline):**
-  ```typescript
-  export interface OllamaGenerateResponse {
-    model: string;
-    created_at: string; // ISO 8601 timestamp
-    response: string; // The generated summary text
-    done: boolean; // Should be true if stream=false and generation succeeded
-    // Optional fields detailing context, timings, etc. are ignored for MVP
-    // total_duration?: number;
-    // load_duration?: number;
-    // prompt_eval_count?: number;
-    // prompt_eval_duration?: number;
-    // eval_count?: number;
-    // eval_duration?: number;
-  }
-  ```
-  _(Note: Error responses might have a different structure, e.g., `{ "error": "message" }`)_
-
-## 3. Database Schemas
-
-- **N/A:** This application does not use a database for MVP; data is persisted to the local filesystem.
-
-## 4. State File Schemas (Local Filesystem Persistence)
-
-These describe the format of files saved in the `output/YYYY-MM-DD/` directory.
-
-### `{storyId}_data.json`
-
-- **Purpose:** Stores fetched story metadata and associated comments.
-- **Format:** JSON
-- **Schema Definition (Matches `Story` type fields relevant at time of saving):**
-  ```json
-  {
-    "storyId": "string",
-    "title": "string",
-    "articleUrl": "string | null",
-    "hnUrl": "string",
-    "points": "number | undefined",
-    "numComments": "number | undefined",
-    "fetchedAt": "string", // ISO 8601 timestamp
-    "comments": [
-      // Array of Comment objects
-      {
-        "commentId": "string",
-        "commentText": "string | null",
-        "author": "string | null",
-        "createdAt": "string" // ISO 8601 timestamp
-      }
-      // ... more comments
-    ]
-  }
-  ```
-
-### `{storyId}_article.txt`
-
-- **Purpose:** Stores the successfully scraped plain text content of the linked article.
-- **Format:** Plain Text (`.txt`)
-- **Schema Definition:** N/A (Content is the raw extracted string). File only exists if scraping was successful.
-
-### `{storyId}_summary.json`
-
-- **Purpose:** Stores the generated article and discussion summaries.
-- **Format:** JSON
-- **Schema Definition:**
-  ```json
-  {
-    "storyId": "string",
-    "articleSummary": "string | null", // Null if scraping failed or summarization failed
-    "discussionSummary": "string | null", // Null if no comments or summarization failed
-    "summarizedAt": "string" // ISO 8601 timestamp
-  }
-  ```
-
-## Change Log
-
-| Change        | Date       | Version | Description                  | Author      |
-| ------------- | ---------- | ------- | ---------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial draft based on Epics | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/demo.md

@@ -1,158 +0,0 @@
-# Demonstration of the Full BMad Workflow Agent Gem Usage
-
-**Welcome to the complete end-to-end walkthrough of the BMad Method V2!** This demonstration showcases the power of AI-assisted software development using a phased agent approach. You'll see how each specialized agent (BA, PM, Architect, PO/SM) contributes to the project lifecycle - from initial concept to implementation-ready plans.
-
-Each section includes links to **full Gemini interaction transcripts**, allowing you to witness the remarkable collaborative process between human and AI. The demo folder contains all output artifacts that flow between agents, creating a cohesive development pipeline.
-
-What makes this V2 methodology exceptional is how the agents work in **interactive phases**, pausing at key decision points for your input rather than dumping massive documents at once. This creates a truly collaborative experience where you shape the outcome while the AI handles the heavy lifting.
-
-Follow along from concept to code-ready project plan and see how this workflow transforms software development!
-
-## BA Brainstorming
-
-The following link shows the full chat thread with the BA demonstrating many features of this amazing agent. I started out not even knowing what to build, and it helped me ideate with the goal of something interesting for tutorial purposes, refine it, do some deep research (in thinking mode, I did not switch models), gave some great alternative details and ideas, prompted me section by section eventually to produce the brief. It worked amazingly well. You can read the full transcript and output here:
-
-https://gemini.google.com/share/fec063449737
-
-## PM Brainstorming (Oops it was not the PM LOL)
-
-I took the final output md brief with prompt for the PM at the end of the last chat and created a google doc to make it easier to share with the PM (I could have probably just pasted it into the new chat, but it's easier if I want to start over). In Google Docs it's so easy to just create a new doc, right click and select 'Paste from Markdown', then click in the title and it will automatically name and save it with the title of the document. I then started a chat with the 2-PM Gem, also in Gemini 2.5 Pro thinking mode by attaching the Google doc and telling it to reference the prompt. This is the transcript. I realized that I accidentally had pasted the BA prompt also into the PM prompt, so this actually ended up producing a pretty nicely refined brief 2.0 instead LOL
-
-https://g.co/gemini/share/3e09f04138f2
-
-So I took that output file and put it into the actual BA again to produce a new version with prompt as seen in [this file](final-brief-with-pm-prompt.txt) ([md version](final-brief-with-pm-prompt.md)).
-
-## PM Brainstorming Take 2
-
-I will be going forward with the rest of the process not use Google Docs even though it's preferred and instead attach txt attachments of previous phase documents, this is required or else the link will be un-sharable.
-
-Of note here is how I am not passive in this process and you should not be either - I looked at its proposed epics in its first PRD draft after answering the initial questions and spotting something really dumb, it had a final epic for doing file output and logging all the way at the end - when really this should be happening incrementally with each epic. The Architect or PO I hope would have caught this later and the PM might also if I let it get to the checklist phase, but if you can work with it you will have quicker results and better outcomes.
-
-Also notice, since we came to the PM with the amazing brief + prompt embedded in it - it only had like 1 question before producing the first draft - amazing!!!
-
-The PM did a great job of asking the right questions, and producing the [Draft PRD](prd.txt) ([md version](prd.md)), and each epic, [1](epic1.txt) ([md version](epic1.md)), [2](epic2.txt) ([md version](epic2.md)), [3](epic3.txt) ([md version](epic3.md)), [4](epic4.txt) ([md version](epic4.md)), [5](epic5.txt) ([md version](epic5.md)).
-
-The beauty of these new V2 Agents is they pause for you to answer questions or review the document generation section by section - this is so much better than receiving a massive document dump all at once and trying to take it all in. in between each piece you can ask questions or ask for changes - so easy - so powerful!
-
-After the drafts were done, it then ran the checklist - which is the other big game changer feature of the V2 BMAD Method. Waiting for the output final decision from the checklist run can be exciting haha!
-
-Getting that final PRD & EPIC VALIDATION SUMMARY and seeing it all passing is a great feeling.
-
-[Here is the full chat summary](https://g.co/gemini/share/abbdff18316b).
-
-## Architect (Terrible Architect - already fired and replaced in take 2)
-
-I gave the architect the drafted PRD and epics. I call them all still drafts because the architect or PO could still have some findings or updates - but hopefully not for this very simple project.
-
-I started off the fun with the architect by saying 'the prompt to respond to is in the PRD at the end in a section called 'Initial Architect Prompt' and we are in architecture creation mode - all PRD and epics planned by the PM are attached'
-
-NOTE - The architect just plows through and produces everything at once and runs the checklist - need to improve the gem and agent to be more workflow focused in a future update! Here is the [initial crap it produced](botched-architecture.md) - don't worry I fixed it, it's much better in take 2!
-
-There is one thing that is a pain with both Gemini and ChatGPT - output of markdown with internal markdown or mermaid sections screws up the output formatting where it thinks the start of inner markdown is the end to its total output block - this is because the reality is everything you are seeing in response from the LLM is already markdown, just being rendered by the UI! So the fix is simple - I told it "Since you already default respond in markdown - can you not use markdown blocks and just give the document as standard chat output" - this worked perfect, and nested markdown was properly still wrapped!
-
-I updated the agent at this point to fix this output formatting for all gems and adjusted the architect to progress document by document prompting in between to get clarifications, suggest tradeoffs or what it put in place, etc., and then confirm with me if I like all the draft docs we got 1 by 1 and then confirm I am ready for it to run the checklist assessment. Improved usage of this is shown in the next section Architect Take 2 next.
-
-If you want to see my annoying chat with this lame architect gem that is now much better - [here you go](https://g.co/gemini/share/0a029a45d70b).
-
-{I corrected the interaction model and added YOLO mode to the architect, and tried a fresh start with the improved gem in take 2.}
-
-## Architect Take 2 (Our amazing new architect)
-
-Same initial prompt as before but with the new and improved architect! I submitted that first prompt again and waited in anticipation to see if it would go insane again.
-
-So far success - it confirmed it was not to go all YOLO on me!
-
-Our new architect is SO much better, and also fun '(Pirate voice) Aye, yargs be a fine choice, matey!' - firing the previous architect was a great decision!
-
-It gave us our [tech stack](tech-stack.txt) ([md version](tech-stack.md)) - the tech-stack looks great, it did not produce wishy-washy ambiguous selections like the previous architect would!
-
-I did mention we should call out the specific decisions to not use axios and dotenv so the LLM would not try to use it later. Also I suggested adding Winston and it helped me know it had a better simpler idea for MVP for file logging! Such a great helper now! I really hope I never see that old V1 architect again, I don't think he was at all qualified to even mop the floors.
-
-When I got the [project structure document](project-structure.txt) ([md version](project-structure.md)), I was blown away - you will see in the chat transcript how it was formatted - I was able to copy the whole response put it in an md file and no more issues with sub sections, just removed the text basically saying here is your file! Once confirmed it was md, I changed it to txt for pass off later potentially to the PO.
-
-Here are the remaining docs it did with me one at a time before running the checklist:
-
-- [Architecture](architecture.txt) ([md version](architecture.md)) - the 'Core Workflow / Sequence Diagram (Main Pipeline)' diagram was impressive - one other diagram had a mermaid bugs - I updated the agent and fixed the bugs, these should hopefully not occur again - it was the most common LLM mermaid bug I have gotten across models
-- [Data Models](data-models.txt) ([md version](data-models.md)) - another complex file easy to just get the end of message ... copy the response and paste into markdown, perfect result!
-- [API Reference](api-reference.txt) ([md version](api-reference.md))
-- [Env Vars](environment-vars.txt) ([md version](environment-vars.md))
-- [Coding Standards](coding-standards.txt) ([md version](coding-standards.md))
-- [Testing Strategy](testing-strategy.txt) ([md version](testing-strategy.md)) - It really nailed this one, even having me ensure it captured by concerns about testing each epic with scripts incrementally - which I did confirm was awesome!
-
-It then confirmed it was done with all the artifacts and ready to assess with its checklist! Here are the results: 5 minor points and great questions - some I answered, one I didn't understand and it explained it to me in detail!
-
-I made the updates, and it also proposed a new file for this project specifically! [Prompts](prompts.txt) ([md version](prompts.md)) - I did have it take the output from that to ensure its referenced where needed including epic 4 and coding standards, it helped me regenerate epic 4 with the changes.
-
-We were done, I told it great job, the output it gave me next was perfect showing the complete function of the multiphased agent! Here is a snippet!
-
-```text
-Next Steps:
-
-The project can now move into the implementation phase, using these architecture documents as the blueprint. Development agents can be tasked with implementing the stories within each Epic, following the defined structure, standards, and testing strategy.
-
-As the 3-Architect, I can switch to Mode 3: Master Architect Advisory if you need further assistance during development, such as:
-
-Explaining architectural concepts.
-Advising on implementation challenges.
-Evaluating potential changes or enhancements.
-Helping manage technical debt.
-```
-
-Here is the [full massive architecture discussion link](https://g.co/gemini/share/4fedc292e068)!
-
-## PO-SM
-
-This mode is WILD in Gemini 2.5 Pro with its massive 1 million context window - holy crap! It was able to analyze every artifact together - since there is a 10 document attach limit I created a [Combined Artifacts](combined-artifacts-for-posm.txt) ([md version](combined-artifacts-for-posm.md)) which adds all 5 epic files in it.
-
-There was a ton of output running through the checklist - but the amazing part is it considered it all and output this (in better formatted markdown I didn't capture here well). TL;DR of the following - it caught two great finds! It called out that story 1.2 still calls for dotenv which we are not going to use after working with the architect, and also it is looking for a prompts.md that is called out - but I forgot to attach it, so it caught that! So I corrected story 1.2 and we are ready to proceed with development!
-
-VALIDATION SUMMARY
-Category Statuses
-Category Status Critical Issues
-
-1. Project Setup & Initialization PASS
-2. Infrastructure & Deployment Sequencing PASS
-3. External Dependencies & Integrations PASS
-4. User/Agent Responsibility Delineation PASS
-5. Feature Sequencing & Dependencies PASS
-6. MVP Scope Alignment PASS
-7. Risk Management & Practicality PASS
-8. Documentation & Handoff PASS
-9. Post-MVP Considerations PASS
-   OVERALL PASS No critical deficiencies identified.
-
-Export to Sheets
-Critical Deficiencies
-None identified.
-Recommendations
-
-While not critical, Story 1.2 could explicitly state npm install {dotenv library} rather than just referencing the library name, for absolute clarity, although the plan specifies native Node.js .env support which negates the need for a library [111, 549]. Correction: The plan correctly states native support is used and no external package is needed [549], removing this minor concern. The reference to installing dotenv in Story 1.2 [111-112] seems contradictory to the environment-vars.txt [549] and tech-stack.txt [867] which state native support is used and dotenv is not needed. This should be clarified/corrected in Story 1.2. Update: Reviewing Story 1.2 [111], it does explicitly require installing dotenv, which contradicts ENV [549], ARCH [72], TS [867], and PRD [752] (which implies native support via .env.example). This inconsistency needs resolution. Decision: Assuming ENV, ARCH, TS, PRD are correct and Story 1.2 requirement for dotenv package is an error. Will proceed assuming NO dotenv package required.
-
-Consider adding a docs/prompts.md file explicitly, as referenced in ARCH [89] and E4 Story 4.2 [321], even if prompts are simple initially. Update: E4 Story 4.2 [321-325] does require creating docs/prompts.md and referencing it. This seems sufficient.
-
-Final Decision
-
-APPROVED: The plan is comprehensive, meticulously detailed across PRD, Architecture, Epics, and supporting documents. The sequencing is logical, dependencies are managed, risks acknowledged, and the scope aligns tightly with MVP goals. The technical constraints are respected, and the use of stage testing utilities significantly enhances testability and validation. The identified inconsistency regarding the dotenv package is noted but assumed resolved in favour of native Node.js support based on multiple other document references. The plan is ready for implementation.
-
-Transitioning to SM Mode can proceed upon user confirmation or if auto-proceeding.
-
-(full chat link in the next section)
-
-## PO-SM Story Generation
-
-This is only for demonstration as I do not like to work this way, at this point I want to be into the project - but for fun and testing, I wanted to verify the gem can produce quality stories, potentially multiple at once in case someone were wanting to use this more like taskmaster.
-
-The output looks decent, I still prefer doing this in the IDE with Sonnet 3.5/3.7 though 1 story at a time with the SM, then use the Dev. Mainly because it's still possible you might want to change something story to story - but this is just a preference, and this method of generating all the stories at once might work well for you - experiment and let me know what you find!
-
-- [Story Drafts Epic 1](epic-1-stories-demo.md)
-- [Story Drafts Epic 2](epic-2-stories-demo.md)
-- [Story Drafts Epic 3](epic-3-stories-demo.md)
-  etc...
-
-Here is the full [4-POSM chat record](https://g.co/gemini/share/9ab02d1baa18).
-
-Ill post the link to the video and final project here if you want to see the final results of the app build - but I am beyond extatic at how well this planning workflow is now tuned with V2.
-
-Thanks if you read this far.
-
-- BMad

V2-FULL-DEMO-WALKTHROUGH/environment-vars.md

@@ -1,43 +0,0 @@
-# BMad Hacker Daily Digest Environment Variables
-
-## Configuration Loading Mechanism
-
-Environment variables for this project are managed using a standard `.env` file in the project root. The application leverages the native support for `.env` files built into Node.js (v20.6.0 and later) , meaning **no external `dotenv` package is required**.
-
-Variables defined in the `.env` file are automatically loaded into `process.env` when the Node.js application starts. Accessing and potentially validating these variables should be centralized, ideally within the `src/utils/config.ts` module .
-
-## Required Variables
-
-The following table lists the environment variables used by the application. An `.env.example` file should be maintained in the repository with these variables set to placeholder or default values .
-
-| Variable Name                   | Description                                                       | Example / Default Value                  | Required? | Sensitive? | Source        |
-| :------------------------------ | :---------------------------------------------------------------- | :--------------------------------------- | :-------- | :--------- | :------------ |
-| `OUTPUT_DIR_PATH`               | Filesystem path for storing output data artifacts                 | `./output`                               | Yes       | No         | Epic 1        |
-| `MAX_COMMENTS_PER_STORY`        | Maximum number of comments to fetch per HN story                  | `50`                                     | Yes       | No         | PRD           |
-| `OLLAMA_ENDPOINT_URL`           | Base URL for the local Ollama API instance                        | `http://localhost:11434`                 | Yes       | No         | Epic 4        |
-| `OLLAMA_MODEL`                  | Name of the Ollama model to use for summarization                 | `llama3`                                 | Yes       | No         | Epic 4        |
-| `EMAIL_HOST`                    | SMTP server hostname for sending email                            | `smtp.example.com`                       | Yes       | No         | Epic 5        |
-| `EMAIL_PORT`                    | SMTP server port                                                  | `587`                                    | Yes       | No         | Epic 5        |
-| `EMAIL_SECURE`                  | Use TLS/SSL (`true` for port 465, `false` for 587/STARTTLS)       | `false`                                  | Yes       | No         | Epic 5        |
-| `EMAIL_USER`                    | Username for SMTP authentication                                  | `user@example.com`                       | Yes       | **Yes**    | Epic 5        |
-| `EMAIL_PASS`                    | Password for SMTP authentication                                  | `your_smtp_password`                     | Yes       | **Yes**    | Epic 5        |
-| `EMAIL_FROM`                    | Sender email address (may need specific format)                   | `"BMad Digest <digest@example.com>"`     | Yes       | No         | Epic 5        |
-| `EMAIL_RECIPIENTS`              | Comma-separated list of recipient email addresses                 | `recipient1@example.com,r2@test.org`     | Yes       | No         | Epic 5        |
-| `NODE_ENV`                      | Runtime environment (influences some library behavior)            | `development`                            | No        | No         | Standard Node |
-| `SCRAPE_TIMEOUT_MS`             | _Optional:_ Timeout in milliseconds for article scraping requests | `15000` (15s)                            | No        | No         | Good Practice |
-| `OLLAMA_TIMEOUT_MS`             | _Optional:_ Timeout in milliseconds for Ollama API requests       | `120000` (2min)                          | No        | No         | Good Practice |
-| `LOG_LEVEL`                     | _Optional:_ Control log verbosity (e.g., debug, info)             | `info`                                   | No        | No         | Good Practice |
-| `MAX_COMMENT_CHARS_FOR_SUMMARY` | _Optional:_ Max chars of combined comments sent to LLM            | 10000 / null (uses all if not set)       | No        | No         | Arch Decision |
-| `SCRAPER_USER_AGENT`            | _Optional:_ Custom User-Agent header for scraping requests        | "BMadHackerDigest/0.1" (Default in code) | No        | No         | Arch Decision |
-
-## Notes
-
-- **Secrets Management:** Sensitive variables (`EMAIL_USER`, `EMAIL_PASS`) must **never** be committed to version control. The `.env` file should be included in `.gitignore` (as per boilerplate ).
-- **`.env.example`:** Maintain an `.env.example` file in the repository mirroring the variables above, using placeholders or default values for documentation and local setup .
-- **Validation:** It is recommended to implement validation logic in `src/utils/config.ts` to ensure required variables are present and potentially check their format on application startup .
-
-## Change Log
-
-| Change        | Date       | Version | Description                           | Author      |
-| ------------- | ---------- | ------- | ------------------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Epics requirements | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/environment-vars.txt

@@ -1,43 +0,0 @@
-# BMad Hacker Daily Digest Environment Variables
-
-## Configuration Loading Mechanism
-
-Environment variables for this project are managed using a standard `.env` file in the project root. The application leverages the native support for `.env` files built into Node.js (v20.6.0 and later) , meaning **no external `dotenv` package is required**.
-
-Variables defined in the `.env` file are automatically loaded into `process.env` when the Node.js application starts. Accessing and potentially validating these variables should be centralized, ideally within the `src/utils/config.ts` module .
-
-## Required Variables
-
-The following table lists the environment variables used by the application. An `.env.example` file should be maintained in the repository with these variables set to placeholder or default values .
-
-| Variable Name                   | Description                                                       | Example / Default Value                  | Required? | Sensitive? | Source        |
-| :------------------------------ | :---------------------------------------------------------------- | :--------------------------------------- | :-------- | :--------- | :------------ |
-| `OUTPUT_DIR_PATH`               | Filesystem path for storing output data artifacts                 | `./output`                               | Yes       | No         | Epic 1        |
-| `MAX_COMMENTS_PER_STORY`        | Maximum number of comments to fetch per HN story                  | `50`                                     | Yes       | No         | PRD           |
-| `OLLAMA_ENDPOINT_URL`           | Base URL for the local Ollama API instance                        | `http://localhost:11434`                 | Yes       | No         | Epic 4        |
-| `OLLAMA_MODEL`                  | Name of the Ollama model to use for summarization                 | `llama3`                                 | Yes       | No         | Epic 4        |
-| `EMAIL_HOST`                    | SMTP server hostname for sending email                            | `smtp.example.com`                       | Yes       | No         | Epic 5        |
-| `EMAIL_PORT`                    | SMTP server port                                                  | `587`                                    | Yes       | No         | Epic 5        |
-| `EMAIL_SECURE`                  | Use TLS/SSL (`true` for port 465, `false` for 587/STARTTLS)       | `false`                                  | Yes       | No         | Epic 5        |
-| `EMAIL_USER`                    | Username for SMTP authentication                                  | `user@example.com`                       | Yes       | **Yes**    | Epic 5        |
-| `EMAIL_PASS`                    | Password for SMTP authentication                                  | `your_smtp_password`                     | Yes       | **Yes**    | Epic 5        |
-| `EMAIL_FROM`                    | Sender email address (may need specific format)                   | `"BMad Digest <digest@example.com>"`     | Yes       | No         | Epic 5        |
-| `EMAIL_RECIPIENTS`              | Comma-separated list of recipient email addresses                 | `recipient1@example.com,r2@test.org`     | Yes       | No         | Epic 5        |
-| `NODE_ENV`                      | Runtime environment (influences some library behavior)            | `development`                            | No        | No         | Standard Node |
-| `SCRAPE_TIMEOUT_MS`             | _Optional:_ Timeout in milliseconds for article scraping requests | `15000` (15s)                            | No        | No         | Good Practice |
-| `OLLAMA_TIMEOUT_MS`             | _Optional:_ Timeout in milliseconds for Ollama API requests       | `120000` (2min)                          | No        | No         | Good Practice |
-| `LOG_LEVEL`                     | _Optional:_ Control log verbosity (e.g., debug, info)             | `info`                                   | No        | No         | Good Practice |
-| `MAX_COMMENT_CHARS_FOR_SUMMARY` | _Optional:_ Max chars of combined comments sent to LLM            | 10000 / null (uses all if not set)       | No        | No         | Arch Decision |
-| `SCRAPER_USER_AGENT`            | _Optional:_ Custom User-Agent header for scraping requests        | "BMadHackerDigest/0.1" (Default in code) | No        | No         | Arch Decision |
-
-## Notes
-
-- **Secrets Management:** Sensitive variables (`EMAIL_USER`, `EMAIL_PASS`) must **never** be committed to version control. The `.env` file should be included in `.gitignore` (as per boilerplate ).
-- **`.env.example`:** Maintain an `.env.example` file in the repository mirroring the variables above, using placeholders or default values for documentation and local setup .
-- **Validation:** It is recommended to implement validation logic in `src/utils/config.ts` to ensure required variables are present and potentially check their format on application startup .
-
-## Change Log
-
-| Change        | Date       | Version | Description                           | Author      |
-| ------------- | ---------- | ------- | ------------------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Epics requirements | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/epic-1-stories-demo.md

@@ -1,391 +0,0 @@
-Okay, transitioning to **SM Mode**.
-
-I will now generate the stories for **Epic 1: Project Initialization & Core Setup**, as requested for demonstration purposes.
-
-I will use the details from Epic 1 in `combined-artifacts-for-posm.txt`, the `story-template.txt`, and extract relevant technical context from the supporting documents (`architecture.txt`, `project-structure.txt`, `tech-stack.txt`, `environment-vars.txt`, `testing-strategy.txt`).
-
-**Note:** As identified during PO Mode validation, Story 1.2 contained a requirement to install the `dotenv` package [111-112], which contradicts multiple other documents stating native Node.js support is used and the package is unnecessary (`ENV` [549], `ARCH` [72], `TS` [867], `PRD` [752]). The following story for 1.2 has been generated based on the **correction** that the `dotenv` package is **not required** and native Node.js functionality should be used.
-
-Here is the report containing the generated stories for Epic 1:
-
----
-
-## **Stories Report: Epic 1**
-
-**File: ai/stories/1.1.story.md**
-
-```markdown
-# Story 1.1: Initialize Project from Boilerplate
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place. [96]
-
-**Context:** This is the foundational story for the entire project. It establishes the core development environment, tooling, and standard scripts based on the `bmad-boilerplate` template, as required by the PRD [706, 713, 784] and Architecture [43]. All subsequent development relies on the successful completion of this setup.
-
-## Detailed Requirements
-
-- Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory. [97]
-- Initialize a git repository in the project root directory (if not already done by cloning). [98]
-- Ensure the `.gitignore` file from the boilerplate is present. [99]
-- Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`. [100]
-- Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase. [101]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The project directory contains the files and structure from `bmad-boilerplate`. [102]
-- AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`. [103]
-- AC3: `npm run lint` command completes successfully without reporting any linting errors. [104]
-- AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. [105] Running it a second time should result in no changes. [106]
-- AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage). [107]
-- AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output. [108]
-- AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate. [109, 632]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create/Copy: All files from `bmad-boilerplate` (e.g., `package.json`, `tsconfig.json`, `.eslintrc.js`, `.prettierrc.js`, `.gitignore`, initial `src/` structure if any).
-  - Files to Modify: None initially, verification via script execution.
-  - _(Hint: See `docs/project-structure.md` [813-825] for the target overall layout derived from the boilerplate)._
-- **Key Technologies:**
-  - Node.js 22.x [851], npm [100], Git [98], TypeScript [846], Jest [889], ESLint [893], Prettier [896].
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - N/A for this story.
-- **Data Structures:**
-  - N/A for this story.
-- **Environment Variables:**
-  - N/A directly used, but `.gitignore` [109] should cover `.env`. Boilerplate includes `.env.example` [112].
-  - _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
-- **Coding Standards Notes:**
-  - Ensure boilerplate scripts (`lint`, `format`) run successfully. [101]
-  - Adhere to ESLint/Prettier rules defined in the boilerplate. [746]
-
-## Tasks / Subtasks
-
-- [ ] Obtain the `bmad-boilerplate` content (clone or copy).
-- [ ] Place boilerplate content into the project's root directory.
-- [ ] Initialize git repository (`git init`).
-- [ ] Verify `.gitignore` exists and is correctly sourced from boilerplate.
-- [ ] Run `npm install` to install dependencies.
-- [ ] Execute `npm run lint` and verify successful completion without errors.
-- [ ] Execute `npm run format` and verify successful completion. Run again to confirm no further changes.
-- [ ] Execute `npm run test` and verify successful execution (no tests found is OK).
-- [ ] Execute `npm run build` and verify `dist/` directory creation and successful completion.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** N/A for this story (focus is project setup). [915]
-- **Integration Tests:** N/A for this story. [921]
-- **Manual/CLI Verification:**
-  - Verify file structure matches boilerplate (AC1).
-  - Check for `node_modules/` directory (AC2).
-  - Run `npm run lint` (AC3).
-  - Run `npm run format` twice (AC4).
-  - Run `npm run test` (AC5).
-  - Run `npm run build`, check for `dist/` (AC6).
-  - Inspect `.gitignore` contents (AC7).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/1.2.story.md**
-
-```markdown
-# Story 1.2: Setup Environment Configuration
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions and utilizing native Node.js support. [110, 549]
-
-**Context:** This story builds on the initialized project (Story 1.1). It sets up the critical mechanism for managing configuration parameters like API keys and file paths using standard `.env` files, which is essential for security and flexibility. It leverages Node.js's built-in `.env` file loading [549, 867], meaning **no external package installation is required**. This corrects the original requirement [111-112] based on `docs/environment-vars.md` [549] and `docs/tech-stack.md` [867].
-
-## Detailed Requirements
-
-- Verify the `.env.example` file exists (from boilerplate). [112]
-- Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`. [113]
-- Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default). [114]
-- Implement a utility module (e.g., `src/utils/config.ts`) that reads environment variables **directly from `process.env`** (populated natively by Node.js from the `.env` file at startup). [115, 550]
-- The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`). [116] It is recommended to include basic validation (e.g., checking if required variables are present). [634]
-- Ensure the `.env` file is listed in `.gitignore` and is not committed. [117, 632]
-
-## Acceptance Criteria (ACs)
-
-- AC1: **(Removed)** The chosen `.env` library... is listed under `dependencies`. (Package not needed [549]).
-- AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`. [119]
-- AC3: The `.env` file exists locally but is NOT tracked by git. [120]
-- AC4: A configuration module (`src/utils/config.ts` or similar) exists and successfully reads the `OUTPUT_DIR_PATH` value **from `process.env`** when the application starts. [121]
-- AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code via the config module. [122]
-- AC6: The `.env` file is listed in the `.gitignore` file. [117]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/utils/config.ts`.
-  - Files to Modify: `.env.example`, `.gitignore` (verify inclusion of `.env`). Create local `.env`.
-  - _(Hint: See `docs/project-structure.md` [822] for utils location)._
-- **Key Technologies:**
-  - Node.js 22.x (Native `.env` support >=20.6) [549, 851]. TypeScript [846].
-  - **No `dotenv` package required.** [549, 867]
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - N/A for this story.
-- **Data Structures:**
-  - Potentially an interface for the exported configuration object in `config.ts`.
-  - _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
-- **Environment Variables:**
-  - Reads `OUTPUT_DIR_PATH` from `process.env`. [116]
-  - Defines `OUTPUT_DIR_PATH` in `.env.example`. [113]
-  - _(Hint: See `docs/environment-vars.md` [559] for this variable)._
-- **Coding Standards Notes:**
-  - `config.ts` should export configuration values clearly.
-  - Consider adding validation logic in `config.ts` to check for the presence of required environment variables on startup. [634]
-
-## Tasks / Subtasks
-
-- [ ] Verify `bmad-boilerplate` provided `.env.example`.
-- [ ] Add `OUTPUT_DIR_PATH=./output` to `.env.example`.
-- [ ] Create `.env` file by copying `.env.example`.
-- [ ] Verify `.env` is included in `.gitignore`.
-- [ ] Create `src/utils/config.ts`.
-- [ ] Implement logic in `config.ts` to read `OUTPUT_DIR_PATH` directly from `process.env`.
-- [ ] Export the loaded `OUTPUT_DIR_PATH` value from `config.ts`.
-- [ ] (Optional but Recommended) Add validation in `config.ts` to ensure `OUTPUT_DIR_PATH` is defined in `process.env`.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:**
-  - Write unit tests for `src/utils/config.ts`. [915]
-  - Use `process.env` manipulation (e.g., temporarily setting `process.env.OUTPUT_DIR_PATH` within the test) to verify the module reads and exports the value correctly.
-  - Test validation logic (e.g., if it throws an error when a required variable is missing). [920]
-- **Integration Tests:** N/A for this story. [921]
-- **Manual/CLI Verification:**
-  - Check `.env.example` content (AC2).
-  - Verify `.env` exists locally but not in git status (AC3, AC6).
-  - Code inspection of `src/utils/config.ts` (AC4).
-  - Later stories (1.3, 1.4) will consume this module, verifying AC5 implicitly.
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Implemented using native Node.js .env support, no external package installed. Added basic validation.}
-- **Change Log:**
-  - Initial Draft (Corrected requirement to use native .env support instead of installing `dotenv` package).
-```
-
----
-
-**File: ai/stories/1.3.story.md**
-
-```markdown
-# Story 1.3: Implement Basic CLI Entry Point & Execution
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic. [123]
-
-**Context:** This story builds upon the project setup (Story 1.1) and environment configuration (Story 1.2). It creates the main starting point (`src/index.ts`) for the CLI application. This file will be executed by the `npm run dev` (using `ts-node`) and `npm run start` (using compiled code) scripts provided by the boilerplate. It verifies that the basic execution flow and configuration loading are functional. [730, 755]
-
-## Detailed Requirements
-
-- Create the main application entry point file at `src/index.ts`. [124]
-- Implement minimal code within `src/index.ts` to:
-  - Import the configuration loading mechanism (from Story 1.2, e.g., `import config from './utils/config';`). [125]
-  - Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up..."). [126]
-  - (Optional) Log the loaded `OUTPUT_DIR_PATH` from the imported config object to verify config loading. [127]
-- Confirm execution using boilerplate scripts (`npm run dev`, `npm run build`, `npm run start`). [127]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The `src/index.ts` file exists. [128]
-- AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console. [129]
-- AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports like `config.ts`) into the `dist` directory. [130]
-- AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console. [131]
-- AC5: (If implemented) The loaded `OUTPUT_DIR_PATH` is logged to the console during execution via `npm run dev` or `npm run start`. [127]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/index.ts`.
-  - Files to Modify: None.
-  - _(Hint: See `docs/project-structure.md` [822] for entry point location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Uses scripts from `package.json` (`dev`, `start`, `build`) defined in the boilerplate.
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - N/A for this story.
-- **Data Structures:**
-  - Imports configuration object from `src/utils/config.ts` (Story 1.2).
-  - _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
-- **Environment Variables:**
-  - Implicitly uses variables loaded by `config.ts` if the optional logging step [127] is implemented.
-  - _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
-- **Coding Standards Notes:**
-  - Use standard `import` statements.
-  - Use `console.log` initially for the startup message (Logger setup is in Story 1.4).
-
-## Tasks / Subtasks
-
-- [ ] Create the file `src/index.ts`.
-- [ ] Add import statement for the configuration module (`src/utils/config.ts`).
-- [ ] Add `console.log("BMad Hacker Daily Digest - Starting Up...");` (or similar).
-- [ ] (Optional) Add `console.log(\`Output directory: \${config.OUTPUT_DIR_PATH}\`);`
-- [ ] Run `npm run dev` and verify console output (AC2, AC5 optional).
-- [ ] Run `npm run build` and verify successful compilation to `dist/` (AC3).
-- [ ] Run `npm start` and verify console output from compiled code (AC4, AC5 optional).
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** Low value for this specific story, as it's primarily wiring and execution setup. Testing `config.ts` was covered in Story 1.2. [915]
-- **Integration Tests:** N/A for this story. [921]
-- **Manual/CLI Verification:**
-  - Verify `src/index.ts` exists (AC1).
-  - Run `npm run dev`, check console output (AC2, AC5 opt).
-  - Run `npm run build`, check `dist/` exists (AC3).
-  - Run `npm start`, check console output (AC4, AC5 opt).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/1.4.story.md**
-
-```markdown
-# Story 1.4: Setup Basic Logging and Output Directory
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics. [132]
-
-**Context:** This story refines the basic execution setup from Story 1.3. It introduces a simple, reusable logger utility (`src/utils/logger.ts`) for standardized console output [871] and implements the logic to create the necessary date-stamped output directory (`./output/YYYY-MM-DD/`) based on the `OUTPUT_DIR_PATH` configured in Story 1.2. This directory is crucial for persisting intermediate data in later epics (Epics 2, 3, 4). [68, 538, 734, 788]
-
-## Detailed Requirements
-
-- Implement a simple, reusable logging utility module (e.g., `src/utils/logger.ts`). [133] Initially, it can wrap `console.log`, `console.warn`, `console.error`. Provide simple functions like `logInfo`, `logWarn`, `logError`. [134]
-- Refactor `src/index.ts` to use this `logger` for its startup message(s) instead of `console.log`. [134]
-- In `src/index.ts` (or a setup function called by it):
-  - Retrieve the `OUTPUT_DIR_PATH` from the configuration (imported from `src/utils/config.ts` - Story 1.2). [135]
-  - Determine the current date in 'YYYY-MM-DD' format (e.g., using `date-fns` library is recommended [878], needs installation `npm install date-fns --save-prod`). [136]
-  - Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/${formattedDate}`). [137]
-  - Check if the base output directory exists; if not, create it. [138]
-  - Check if the date-stamped subdirectory exists; if not, create it recursively. [139] Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`). Need to import `fs`. [140]
-  - Log (using the new logger utility) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04"). [141]
-- The application should exit gracefully after performing these setup steps (for now). [147]
-
-## Acceptance Criteria (ACs)
-
-- AC1: A logger utility module (`src/utils/logger.ts` or similar) exists and is used for console output in `src/index.ts`. [142]
-- AC2: Running `npm run dev` or `npm start` logs the startup message via the logger. [143]
-- AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist. [144]
-- AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`, based on current date) within the base output directory if it doesn't already exist. [145]
-- AC5: The application logs a message via the logger indicating the full path to the date-stamped output directory created/used for the current execution. [146]
-- AC6: The application exits gracefully after performing these setup steps (for now). [147]
-- AC7: `date-fns` library is added as a production dependency.
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/utils/logger.ts`, `src/utils/dateUtils.ts` (recommended for date formatting logic).
-  - Files to Modify: `src/index.ts`, `package.json` (add `date-fns`), `package-lock.json`.
-  - _(Hint: See `docs/project-structure.md` [822] for utils location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], `fs` module (native) [140], `path` module (native, for joining paths).
-  - `date-fns` library [876] for date formatting (needs `npm install date-fns --save-prod`).
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - Node.js `fs.mkdirSync`. [140]
-- **Data Structures:**
-  - N/A specific to this story, uses config from 1.2.
-  - _(Hint: See `docs/data-models.md` [498-547] for key project data structures)._
-- **Environment Variables:**
-  - Uses `OUTPUT_DIR_PATH` loaded via `config.ts`. [135]
-  - _(Hint: See `docs/environment-vars.md` [559] for this variable)._
-- **Coding Standards Notes:**
-  - Logger should provide simple info/warn/error functions. [134]
-  - Use `path.join` to construct file paths reliably.
-  - Handle potential errors during directory creation (e.g., permissions) using try/catch, logging errors via the new logger.
-
-## Tasks / Subtasks
-
-- [ ] Install `date-fns`: `npm install date-fns --save-prod`.
-- [ ] Create `src/utils/logger.ts` wrapping `console` methods (e.g., `logInfo`, `logWarn`, `logError`).
-- [ ] Create `src/utils/dateUtils.ts` (optional but recommended) with a function to get current date as 'YYYY-MM-DD' using `date-fns`.
-- [ ] Refactor `src/index.ts` to import and use the `logger` instead of `console.log`.
-- [ ] In `src/index.ts`, import `fs` and `path`.
-- [ ] In `src/index.ts`, import and use the date formatting function.
-- [ ] In `src/index.ts`, retrieve `OUTPUT_DIR_PATH` from config.
-- [ ] In `src/index.ts`, construct the full date-stamped directory path using `path.join`.
-- [ ] In `src/index.ts`, add logic using `fs.mkdirSync` (with `{ recursive: true }`) inside a try/catch block to create the directory. Log errors using the logger.
-- [ ] In `src/index.ts`, log the full path of the created/used directory using the logger.
-- [ ] Ensure the script completes and exits after these steps.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:**
-  - Test `src/utils/logger.ts` functions (can spy on `console` methods). [915]
-  - Test `src/utils/dateUtils.ts` function for correct date formatting.
-  - Testing `fs` operations in unit tests can be complex; consider focusing on integration or manual verification for directory creation. Mocking `fs` is an option but might be brittle. [918]
-- **Integration Tests:**
-  - Could write a test that runs the core logic of `src/index.ts` (directory creation part) and uses `mock-fs` or actual file system checks (with cleanup) to verify directory creation. [921, 924]
-- **Manual/CLI Verification:**
-  - Run `npm run dev` or `npm start`.
-  - Check console output uses the logger format (AC1, AC2).
-  - Verify the base output directory (e.g., `./output`) is created if it didn't exist (AC3).
-  - Verify the date-stamped subdirectory (e.g., `./output/2025-05-04`) is created (AC4). Use current date. Delete directories before re-running to confirm creation.
-  - Check console log for the message confirming the output directory path (AC5).
-  - Confirm the process exits cleanly (AC6).
-  - Check `package.json` for `date-fns` dependency (AC7).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-## **End of Report for Epic 1**

V2-FULL-DEMO-WALKTHROUGH/epic-2-stories-demo.md

@@ -1,925 +0,0 @@
-Okay, continuing in **SM Mode**.
-
-Generating the stories for **Epic 2: HN Data Acquisition & Persistence**. This assumes that the foundational work from Epic 1 (project initialization, configuration setup via `src/utils/config.ts`, logger via `src/utils/logger.ts`, and output directory creation logic in `src/index.ts`) is complete and available for use.
-
----
-
-## **Stories Report: Epic 2**
-
-**File: ai/stories/2.1.story.md**
-
-```markdown
-# Story 2.1: Implement Algolia HN API Client
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API. [155]
-
-**Context:** This story creates the primary interface for retrieving data from the external Hacker News API provided by Algolia. It encapsulates the specific API calls (`GET /search` for stories and comments) and data extraction logic into a reusable module (`src/clients/algoliaHNClient.ts`). This client will be used by the main pipeline (Story 2.2) and the stage testing utility (Story 2.4). It builds upon the logger created in Epic 1 (Story 1.4). [54, 60, 62, 77]
-
-## Detailed Requirements
-
-- Create a new module: `src/clients/algoliaHNClient.ts`. [156]
-- Implement an async function `WorkspaceTopStories` within the client: [157]
-  - Use native `Workspace` [749] to call the Algolia HN Search API endpoint for front-page stories (`http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). [4, 6, 7, 157] Adjust `hitsPerPage` if needed to ensure 10 stories.
-  - Parse the JSON response. [158]
-  - Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (use as `articleUrl`), `points`, `num_comments`. [159, 522] Handle potential missing `url` field gracefully (log warning using logger from Story 1.4, treat as null). [160]
-  - Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`). [161]
-  - Return an array of structured story objects (define a `Story` type, potentially in `src/types/hn.ts`). [162, 506-511]
-- Implement a separate async function `WorkspaceCommentsForStory` within the client: [163]
-  - Accept `storyId` (string) and `maxComments` limit (number) as arguments. [163]
-  - Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (`http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`). [12, 13, 14, 164]
-  - Parse the JSON response. [165]
-  - Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`. [165, 524]
-  - Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned. [166]
-  - Return an array of structured comment objects (define a `Comment` type, potentially in `src/types/hn.ts`). [167, 500-505]
-- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. [168] Log errors using the logger utility from Epic 1 (Story 1.4). [169]
-- Define TypeScript interfaces/types for the expected structures of API responses (subset needed) and the data returned by the client functions (`Story`, `Comment`). Place these in `src/types/hn.ts`. [169, 821]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions. [170]
-- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint (`search?tags=front_page&hitsPerPage=10`) and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `num_comments`). [171]
-- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint (`search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`) and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones. [172]
-- AC4: Both functions use the native `Workspace` API internally. [173]
-- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger from Story 1.4. [174] Functions should likely return an empty array or throw a specific error in failure cases for the caller to handle.
-- AC6: Relevant TypeScript types (`Story`, `Comment`) are defined in `src/types/hn.ts` and used within the client module. [175]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/clients/algoliaHNClient.ts`, `src/types/hn.ts`.
-  - Files to Modify: Potentially `src/types/index.ts` if using a barrel file.
-  - _(Hint: See `docs/project-structure.md` [817, 821] for location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
-  - Uses `logger` utility from Epic 1 (Story 1.4).
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - Algolia HN Search API `GET /search` endpoint. [2]
-  - Base URL: `http://hn.algolia.com/api/v1` [3]
-  - Parameters: `tags=front_page`, `hitsPerPage=10` (for stories) [6, 7]; `tags=comment,story_{storyId}`, `hitsPerPage={maxComments}` (for comments) [13, 14].
-  - Check `response.ok` and parse JSON response (`response.json()`). [168, 158, 165]
-  - Handle potential network errors with `try...catch`. [168]
-  - No authentication required. [3]
-  - _(Hint: See `docs/api-reference.md` [2-21] for details)._
-- **Data Structures:**
-  - Define `Comment` interface: `{ commentId: string, commentText: string | null, author: string | null, createdAt: string }`. [501-505]
-  - Define `Story` interface (initial fields): `{ storyId: string, title: string, articleUrl: string | null, hnUrl: string, points?: number, numComments?: number }`. [507-511]
-  - (These types will be augmented in later stories [512-517]).
-  - Reference Algolia response subset schemas in `docs/data-models.md` [521-525].
-  - _(Hint: See `docs/data-models.md` for full details)._
-- **Environment Variables:**
-  - No direct environment variables needed for this client itself (uses hardcoded base URL, fetches comment limit via argument).
-  - _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
-- **Coding Standards Notes:**
-  - Use `async/await` for `Workspace` calls.
-  - Use logger for errors and significant events (e.g., warning if `url` is missing). [160]
-  - Export types and functions clearly.
-
-## Tasks / Subtasks
-
-- [ ] Create `src/types/hn.ts` and define `Comment` and initial `Story` interfaces.
-- [ ] Create `src/clients/algoliaHNClient.ts`.
-- [ ] Import necessary types and the logger utility.
-- [ ] Implement `WorkspaceTopStories` function:
-  - [ ] Construct Algolia URL for top stories.
-  - [ ] Use `Workspace` with `try...catch`.
-  - [ ] Check `response.ok`, log errors if not OK.
-  - [ ] Parse JSON response.
-  - [ ] Map `hits` to `Story` objects, extracting required fields, handling null `url`, constructing `hnUrl`.
-  - [ ] Return array of `Story` objects (or handle error case).
-- [ ] Implement `WorkspaceCommentsForStory` function:
-  - [ ] Accept `storyId` and `maxComments` arguments.
-  - [ ] Construct Algolia URL for comments using arguments.
-  - [ ] Use `Workspace` with `try...catch`.
-  - [ ] Check `response.ok`, log errors if not OK.
-  - [ ] Parse JSON response.
-  - [ ] Map `hits` to `Comment` objects, extracting required fields.
-  - [ ] Filter out comments with null/empty `comment_text`.
-  - [ ] Limit results to `maxComments`.
-  - [ ] Return array of `Comment` objects (or handle error case).
-- [ ] Export functions and types as needed.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Write unit tests for `src/clients/algoliaHNClient.ts`. [919]
-  - Mock the native `Workspace` function (e.g., using `jest.spyOn(global, 'fetch')`). [918]
-  - Test `WorkspaceTopStories`: Provide mock successful responses (valid JSON matching Algolia structure [521-523]) and verify correct parsing, mapping to `Story` objects [171], and `hnUrl` construction. Test with missing `url` field. Test mock error responses (network error, non-OK status) and verify error logging [174] and return value.
-  - Test `WorkspaceCommentsForStory`: Provide mock successful responses [524-525] and verify correct parsing, mapping to `Comment` objects, filtering of empty comments, and limiting by `maxComments` [172]. Test mock error responses and verify logging [174].
-  - Verify `Workspace` was called with the correct URLs and parameters [171, 172].
-- **Integration Tests:** N/A for this client module itself, but it will be used in pipeline integration tests later. [921]
-- **Manual/CLI Verification:** Tested indirectly via Story 2.2 execution and directly via Story 2.4 stage runner. [912]
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.2.story.md**
-
-```markdown
-# Story 2.2: Integrate HN Data Fetching into Main Workflow
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1. [176]
-
-**Context:** This story connects the HN API client created in Story 2.1 to the main application entry point (`src/index.ts`) established in Epic 1 (Story 1.3). It modifies the main execution flow to call the client functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) after the initial setup (logger, config, output directory). It uses the `MAX_COMMENTS_PER_STORY` configuration value loaded in Story 1.2. The fetched data (stories and their associated comments) is held in memory at the end of this stage. [46, 77]
-
-## Detailed Requirements
-
-- Modify the main execution flow in `src/index.ts` (or a main async function called by it, potentially moving logic to `src/core/pipeline.ts` as suggested by `ARCH` [46, 53] and `PS` [818]). **Recommendation:** Create `src/core/pipeline.ts` and a `runPipeline` async function, then call this function from `src/index.ts`.
-- Import the `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) from Story 2.1. [177]
-- Import the configuration module (`src/utils/config.ts`) to access `MAX_COMMENTS_PER_STORY`. [177, 563] Also import the logger.
-- In the main pipeline function, after the Epic 1 setup (config load, logger init, output dir creation):
-  - Call `await fetchTopStories()`. [178]
-  - Log the number of stories fetched (e.g., "Fetched X stories."). [179] Use the logger from Story 1.4.
-  - Retrieve the `MAX_COMMENTS_PER_STORY` value from the config module. Ensure it's parsed as a number. Provide a default if necessary (e.g., 50, matching `ENV` [564]).
-  - Iterate through the array of fetched `Story` objects. [179]
-  - For each `Story`:
-    - Log progress (e.g., "Fetching up to Y comments for story {storyId}..."). [182]
-    - Call `await fetchCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY` value. [180]
-    - Store the fetched comments (the returned `Comment[]`) within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` type/object). [181] Augment the `Story` type definition in `src/types/hn.ts`. [512]
-- Ensure errors from the client functions are handled appropriately (e.g., log error and potentially skip comment fetching for that story).
-
-## Acceptance Criteria (ACs)
-
-- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story using the `algoliaHNClient`. [183]
-- AC2: Logs (via logger) clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories. [184]
-- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config, parsed as a number, and used in the calls to `WorkspaceCommentsForStory`. [185]
-- AC4: After successful execution (before persistence in Story 2.3), `Story` objects held in memory contain a `comments` property populated with an array of fetched `Comment` objects. [186] (Verification via debugger or temporary logging).
-- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `comments: Comment[]` field. [512]
-- AC6: (If implemented) Core logic is moved to `src/core/pipeline.ts` and called from `src/index.ts`. [818]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/core/pipeline.ts` (recommended).
-  - Files to Modify: `src/index.ts`, `src/types/hn.ts`.
-  - _(Hint: See `docs/project-structure.md` [818, 821, 822])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Uses `algoliaHNClient` (Story 2.1), `config` (Story 1.2), `logger` (Story 1.4).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `algoliaHNClient.fetchTopStories()` and `algoliaHNClient.fetchCommentsForStory()`.
-- **Data Structures:**
-  - Augment `Story` interface in `src/types/hn.ts` to include `comments: Comment[]`. [512]
-  - Manipulates arrays of `Story` and `Comment` objects in memory.
-  - _(Hint: See `docs/data-models.md` [500-517])._
-- **Environment Variables:**
-  - Reads `MAX_COMMENTS_PER_STORY` via `config.ts`. [177, 563]
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Use `async/await` for calling client functions.
-  - Structure fetching logic cleanly (e.g., within a loop).
-  - Use the logger for progress and error reporting. [182, 184]
-  - Consider putting the main loop logic inside the `runPipeline` function in `src/core/pipeline.ts`.
-
-## Tasks / Subtasks
-
-- [ ] (Recommended) Create `src/core/pipeline.ts` and define an async `runPipeline` function.
-- [ ] Modify `src/index.ts` to import and call `runPipeline`. Move existing setup logic (logger init, config load, dir creation) into `runPipeline` or ensure it runs before it.
-- [ ] In `pipeline.ts` (or `index.ts`), import `WorkspaceTopStories`, `WorkspaceCommentsForStory` from `algoliaHNClient`.
-- [ ] Import `config` and `logger`.
-- [ ] Call `WorkspaceTopStories` after initial setup. Log count.
-- [ ] Retrieve `MAX_COMMENTS_PER_STORY` from `config`, ensuring it's a number.
-- [ ] Update `Story` type in `src/types/hn.ts` to include `comments: Comment[]`.
-- [ ] Loop through the fetched stories:
-  - [ ] Log comment fetching start for the story ID.
-  - [ ] Call `WorkspaceCommentsForStory` with `storyId` and `maxComments`.
-  - [ ] Handle potential errors from the client function call.
-  - [ ] Assign the returned comments array to the `comments` property of the current story object.
-- [ ] Add temporary logging or use debugger to verify stories in memory contain comments (AC4).
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - If logic is moved to `src/core/pipeline.ts`, unit test `runPipeline`. [916]
-  - Mock `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`). [918]
-  - Mock `config` to provide `MAX_COMMENTS_PER_STORY`.
-  - Mock `logger`.
-  - Verify `WorkspaceTopStories` is called once.
-  - Verify `WorkspaceCommentsForStory` is called for each story returned by the mocked `WorkspaceTopStories`, and that it receives the correct `storyId` and `maxComments` value from config [185].
-  - Verify the results from mocked `WorkspaceCommentsForStory` are correctly assigned to the `comments` property of the story objects.
-- **Integration Tests:**
-  - Could have an integration test for the fetch stage that uses the real `algoliaHNClient` (or a lightly mocked version checking calls) and verifies the in-memory data structure, but this is largely covered by the stage runner (Story 2.4). [921]
-- **Manual/CLI Verification:**
-  - Run `npm run dev`.
-  - Check logs for fetching stories and comments messages [184].
-  - Use debugger or temporary `console.log` in the pipeline code to inspect a story object after the loop and confirm its `comments` property is populated [186].
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Logic moved to src/core/pipeline.ts. Verified in-memory data structure.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.3.story.md**
-
-```markdown
-# Story 2.3: Persist Fetched HN Data Locally
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging. [187]
-
-**Context:** This story follows Story 2.2 where HN data (stories with comments) was fetched and stored in memory. Now, this data needs to be saved to the local filesystem. It uses the date-stamped output directory created in Epic 1 (Story 1.4) and writes one JSON file per story, containing the story metadata and its comments. This persisted data (`{storyId}_data.json`) is the input for subsequent stages (Scraping - Epic 3, Summarization - Epic 4, Email Assembly - Epic 5). [48, 734, 735]
-
-## Detailed Requirements
-
-- Define a consistent JSON structure for the output file content. [188] Example from `docs/data-models.md` [539]: `{ storyId: "...", title: "...", articleUrl: "...", hnUrl: "...", points: ..., numComments: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", commentText: "...", author: "...", createdAt: "...", ... }, ...] }`. Include a timestamp (`WorkspaceedAt`) for when the data was fetched/saved. [190]
-- Import Node.js `fs` (specifically `writeFileSync`) and `path` modules in the pipeline module (`src/core/pipeline.ts` or `src/index.ts`). [190] Import `date-fns` or use `new Date().toISOString()` for timestamp.
-- In the main workflow (`pipeline.ts`), within the loop iterating through stories (immediately after comments have been fetched and added to the story object in Story 2.2): [191]
-  - Get the full path to the date-stamped output directory (this path should be determined/passed from the initial setup logic from Story 1.4). [191]
-  - Generate the current timestamp in ISO 8601 format (e.g., `new Date().toISOString()`) and add it to the story object as `WorkspaceedAt`. [190] Update `Story` type in `src/types/hn.ts`. [516]
-  - Construct the filename for the story's data: `{storyId}_data.json`. [192]
-  - Construct the full file path using `path.join()`. [193]
-  - Prepare the data object to be saved, matching the defined JSON structure (including `storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`).
-  - Serialize the prepared story data object to a JSON string using `JSON.stringify(storyData, null, 2)` for readability. [194]
-  - Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling around the file write. [195]
-  - Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing. [196]
-
-## Acceptance Criteria (ACs)
-
-- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json` (assuming 10 stories were fetched successfully). [197]
-- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`), a `WorkspaceedAt` ISO timestamp, and an array of its fetched `comments`, matching the structure defined in `docs/data-models.md` [538-540]. [198]
-- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`. [199]
-- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors. [200]
-- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `WorkspaceedAt: string` field. [516]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Modify: `src/core/pipeline.ts` (or `src/index.ts`), `src/types/hn.ts`.
-  - _(Hint: See `docs/project-structure.md` [818, 821, 822])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Native `fs` module (`writeFileSync`) [190].
-  - Native `path` module (`join`) [193].
-  - `JSON.stringify` [194].
-  - Uses `logger` (Story 1.4).
-  - Uses output directory path created in Story 1.4 logic.
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - `fs.writeFileSync(filePath, jsonDataString, 'utf-8')`. [195]
-- **Data Structures:**
-  - Uses `Story` and `Comment` types from `src/types/hn.ts`.
-  - Augment `Story` type to include `WorkspaceedAt: string`. [516]
-  - Creates JSON structure matching `{storyId}_data.json` schema in `docs/data-models.md`. [538-540]
-  - _(Hint: See `docs/data-models.md`)._
-- **Environment Variables:**
-  - N/A directly, but relies on `OUTPUT_DIR_PATH` being available from config (Story 1.2) used by the directory creation logic (Story 1.4).
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Use `try...catch` for `writeFileSync` calls. [195]
-  - Use `JSON.stringify` with indentation (`null, 2`) for readability. [194]
-  - Log success/failure clearly using the logger. [196]
-
-## Tasks / Subtasks
-
-- [ ] In `pipeline.ts` (or `index.ts`), import `fs` and `path`.
-- [ ] Update `Story` type in `src/types/hn.ts` to include `WorkspaceedAt: string`.
-- [ ] Ensure the full path to the date-stamped output directory is available within the story processing loop.
-- [ ] Inside the loop (after comments are fetched for a story):
-  - [ ] Get the current ISO timestamp (`new Date().toISOString()`).
-  - [ ] Add the timestamp to the story object as `WorkspaceedAt`.
-  - [ ] Construct the output filename: `{storyId}_data.json`.
-  - [ ] Construct the full file path using `path.join(outputDirPath, filename)`.
-  - [ ] Create the data object matching the specified JSON structure, including comments.
-  - [ ] Serialize the data object using `JSON.stringify(data, null, 2)`.
-  - [ ] Use `try...catch` block:
-    - [ ] Inside `try`: Call `fs.writeFileSync(fullPath, jsonString, 'utf-8')`.
-    - [ ] Inside `try`: Log success message with filename.
-    - [ ] Inside `catch`: Log file writing error with filename.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Testing file system interactions directly in unit tests can be brittle. [918]
-  - Focus unit tests on the data preparation logic: ensure the object created before `JSON.stringify` has the correct structure (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`) based on a sample input `Story` object. [920]
-  - Verify the `WorkspaceedAt` timestamp is added correctly.
-- **Integration Tests:** [921]
-  - Could test the file writing aspect using `mock-fs` or actual file system writes within a temporary directory (created during setup, removed during teardown). [924]
-  - Verify that the correct filename is generated and the content written to the mock/temporary file matches the expected JSON structure [538-540] and content.
-- **Manual/CLI Verification:** [912]
-  - Run `npm run dev`.
-  - Inspect the `output/YYYY-MM-DD/` directory (use current date).
-  - Verify 10 files named `{storyId}_data.json` exist (AC1).
-  - Open a few files, visually inspect the JSON structure, check for all required fields (metadata, `WorkspaceedAt`, `comments` array), and verify comment count <= `MAX_COMMENTS_PER_STORY` (AC2, AC3).
-  - Check console logs for success messages for file writing or any errors (AC4).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Files saved successfully in ./output/YYYY-MM-DD/ directory.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.4.story.md**
-
-```markdown
-# Story 2.4: Implement Stage Testing Utility for HN Fetching
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a separate, executable script that _only_ performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline. [201]
-
-**Context:** This story addresses the PRD requirement [736] for stage-specific testing utilities [764]. It creates a standalone Node.js script (`src/stages/fetch_hn_data.ts`) that replicates the core logic of Stories 2.1, 2.2 (partially), and 2.3. This script will initialize necessary components (logger, config), call the `algoliaHNClient` to fetch stories and comments, and persist the results to the date-stamped output directory, just like the main pipeline does up to this point. This allows isolated testing of the Algolia API interaction and data persistence without running subsequent scraping, summarization, or emailing stages. [57, 62, 912]
-
-## Detailed Requirements
-
-- Create a new standalone script file: `src/stages/fetch_hn_data.ts`. [202]
-- This script should perform the essential setup required _for this stage_:
-  - Initialize the logger utility (from Story 1.4). [203]
-  - Load configuration using the config utility (from Story 1.2) to get `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH`. [203]
-  - Determine the current date ('YYYY-MM-DD') using the utility from Story 1.4. [203]
-  - Construct the date-stamped output directory path. [203]
-  - Ensure the output directory exists (create it recursively if not, reusing logic/utility from Story 1.4). [203]
-- The script should then execute the core logic of fetching and persistence:
-  - Import and use `algoliaHNClient.fetchTopStories` and `algoliaHNClient.fetchCommentsForStory` (from Story 2.1). [204]
-  - Import `fs` and `path`.
-  - Replicate the fetch loop logic from Story 2.2 (fetch stories, then loop to fetch comments for each using loaded `MAX_COMMENTS_PER_STORY` limit). [204]
-  - Replicate the persistence logic from Story 2.3 (add `WorkspaceedAt` timestamp, prepare data object, `JSON.stringify`, `fs.writeFileSync` to `{storyId}_data.json` in the date-stamped directory). [204]
-- The script should log its progress (e.g., "Starting HN data fetch stage...", "Fetching stories...", "Fetching comments for story X...", "Saving data for story X...") using the logger utility. [205]
-- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`. [206]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The file `src/stages/fetch_hn_data.ts` exists. [207]
-- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section. [208]
-- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup (logger, config, output dir), fetch (stories, comments), and persist steps (to JSON files). [209]
-- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (up to the end of Epic 2 functionality). [210]
-- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages (scraping, summarizing, emailing). [211]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/stages/fetch_hn_data.ts`.
-  - Files to Modify: `package.json`.
-  - _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], `ts-node` (via `npm run` script).
-  - Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), directory creation logic (Story 1.4), `algoliaHNClient` (Story 2.1), `fs`/`path` (Story 2.3).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `algoliaHNClient` functions.
-  - Uses `fs.writeFileSync`.
-- **Data Structures:**
-  - Uses `Story`, `Comment` types.
-  - Generates `{storyId}_data.json` files [538-540].
-  - _(Hint: See `docs/data-models.md`)._
-- **Environment Variables:**
-  - Reads `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH` via `config.ts`.
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Structure the script clearly (setup, fetch, persist).
-  - Use `async/await`.
-  - Use logger extensively for progress indication. [205]
-  - Consider wrapping the main logic in an `async` IIFE (Immediately Invoked Function Expression) or a main function call.
-
-## Tasks / Subtasks
-
-- [ ] Create `src/stages/fetch_hn_data.ts`.
-- [ ] Add imports for logger, config, date util, `algoliaHNClient`, `fs`, `path`.
-- [ ] Implement setup logic: initialize logger, load config, get output dir path, ensure directory exists.
-- [ ] Implement main fetch logic:
-  - [ ] Call `WorkspaceTopStories`.
-  - [ ] Get `MAX_COMMENTS_PER_STORY` from config.
-  - [ ] Loop through stories:
-    - [ ] Call `WorkspaceCommentsForStory`.
-    - [ ] Add comments to story object.
-    - [ ] Add `WorkspaceedAt` timestamp.
-    - [ ] Prepare data object for saving.
-    - [ ] Construct full file path for `{storyId}_data.json`.
-    - [ ] Serialize and write to file using `fs.writeFileSync` within `try...catch`.
-    - [ ] Log progress/success/errors.
-- [ ] Add script `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"` to `package.json`.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** Unit tests for the underlying components (logger, config, client, utils) should already exist from previous stories. Unit testing the stage script itself might have limited value beyond checking basic setup calls if the core logic is just orchestrating tested components. [915]
-- **Integration Tests:** N/A specifically for the script, as it _is_ an integration test itself. [921]
-- **Manual/CLI Verification (Primary Test Method for this Story):** [912, 927]
-  - Run `npm run stage:fetch`. [209]
-  - Verify successful execution without errors.
-  - Check console logs for messages specific to fetching and persisting [211].
-  - Inspect the `output/YYYY-MM-DD/` directory and verify the content of the generated `{storyId}_data.json` files match expectations (similar to verification for Story 2.3) [210].
-  - Modify `package.json` to add the script (AC2).
-- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Stage runner script created and tested successfully. package.json updated.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-## **End of Report for Epic 2**
-
-Okay, continuing in **SM Mode**.
-
-Generating the stories for **Epic 2: HN Data Acquisition & Persistence**. This assumes that the foundational work from Epic 1 (project initialization, configuration setup via `src/utils/config.ts`, logger via `src/utils/logger.ts`, and output directory creation logic in `src/index.ts`) is complete and available for use.
-
----
-
-## **Stories Report: Epic 2**
-
-**File: ai/stories/2.1.story.md**
-
-```markdown
-# Story 2.1: Implement Algolia HN API Client
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API. [155]
-
-**Context:** This story creates the primary interface for retrieving data from the external Hacker News API provided by Algolia. It encapsulates the specific API calls (`GET /search` for stories and comments) and data extraction logic into a reusable module (`src/clients/algoliaHNClient.ts`). This client will be used by the main pipeline (Story 2.2) and the stage testing utility (Story 2.4). It builds upon the logger created in Epic 1 (Story 1.4). [54, 60, 62, 77]
-
-## Detailed Requirements
-
-- Create a new module: `src/clients/algoliaHNClient.ts`. [156]
-- Implement an async function `WorkspaceTopStories` within the client: [157]
-  - Use native `Workspace` [749] to call the Algolia HN Search API endpoint for front-page stories (`http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). [4, 6, 7, 157] Adjust `hitsPerPage` if needed to ensure 10 stories.
-  - Parse the JSON response. [158]
-  - Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (use as `articleUrl`), `points`, `num_comments`. [159, 522] Handle potential missing `url` field gracefully (log warning using logger from Story 1.4, treat as null). [160]
-  - Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`). [161]
-  - Return an array of structured story objects (define a `Story` type, potentially in `src/types/hn.ts`). [162, 506-511]
-- Implement a separate async function `WorkspaceCommentsForStory` within the client: [163]
-  - Accept `storyId` (string) and `maxComments` limit (number) as arguments. [163]
-  - Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (`http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`). [12, 13, 14, 164]
-  - Parse the JSON response. [165]
-  - Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`. [165, 524]
-  - Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned. [166]
-  - Return an array of structured comment objects (define a `Comment` type, potentially in `src/types/hn.ts`). [167, 500-505]
-- Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. [168] Log errors using the logger utility from Epic 1 (Story 1.4). [169]
-- Define TypeScript interfaces/types for the expected structures of API responses (subset needed) and the data returned by the client functions (`Story`, `Comment`). Place these in `src/types/hn.ts`. [169, 821]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions. [170]
-- AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint (`search?tags=front_page&hitsPerPage=10`) and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `num_comments`). [171]
-- AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint (`search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`) and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones. [172]
-- AC4: Both functions use the native `Workspace` API internally. [173]
-- AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger from Story 1.4. [174] Functions should likely return an empty array or throw a specific error in failure cases for the caller to handle.
-- AC6: Relevant TypeScript types (`Story`, `Comment`) are defined in `src/types/hn.ts` and used within the client module. [175]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/clients/algoliaHNClient.ts`, `src/types/hn.ts`.
-  - Files to Modify: Potentially `src/types/index.ts` if using a barrel file.
-  - _(Hint: See `docs/project-structure.md` [817, 821] for location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
-  - Uses `logger` utility from Epic 1 (Story 1.4).
-  - _(Hint: See `docs/tech-stack.md` [839-905] for full list)._
-- **API Interactions / SDK Usage:**
-  - Algolia HN Search API `GET /search` endpoint. [2]
-  - Base URL: `http://hn.algolia.com/api/v1` [3]
-  - Parameters: `tags=front_page`, `hitsPerPage=10` (for stories) [6, 7]; `tags=comment,story_{storyId}`, `hitsPerPage={maxComments}` (for comments) [13, 14].
-  - Check `response.ok` and parse JSON response (`response.json()`). [168, 158, 165]
-  - Handle potential network errors with `try...catch`. [168]
-  - No authentication required. [3]
-  - _(Hint: See `docs/api-reference.md` [2-21] for details)._
-- **Data Structures:**
-  - Define `Comment` interface: `{ commentId: string, commentText: string | null, author: string | null, createdAt: string }`. [501-505]
-  - Define `Story` interface (initial fields): `{ storyId: string, title: string, articleUrl: string | null, hnUrl: string, points?: number, numComments?: number }`. [507-511]
-  - (These types will be augmented in later stories [512-517]).
-  - Reference Algolia response subset schemas in `docs/data-models.md` [521-525].
-  - _(Hint: See `docs/data-models.md` for full details)._
-- **Environment Variables:**
-  - No direct environment variables needed for this client itself (uses hardcoded base URL, fetches comment limit via argument).
-  - _(Hint: See `docs/environment-vars.md` [548-638] for all variables)._
-- **Coding Standards Notes:**
-  - Use `async/await` for `Workspace` calls.
-  - Use logger for errors and significant events (e.g., warning if `url` is missing). [160]
-  - Export types and functions clearly.
-
-## Tasks / Subtasks
-
-- [ ] Create `src/types/hn.ts` and define `Comment` and initial `Story` interfaces.
-- [ ] Create `src/clients/algoliaHNClient.ts`.
-- [ ] Import necessary types and the logger utility.
-- [ ] Implement `WorkspaceTopStories` function:
-  - [ ] Construct Algolia URL for top stories.
-  - [ ] Use `Workspace` with `try...catch`.
-  - [ ] Check `response.ok`, log errors if not OK.
-  - [ ] Parse JSON response.
-  - [ ] Map `hits` to `Story` objects, extracting required fields, handling null `url`, constructing `hnUrl`.
-  - [ ] Return array of `Story` objects (or handle error case).
-- [ ] Implement `WorkspaceCommentsForStory` function:
-  - [ ] Accept `storyId` and `maxComments` arguments.
-  - [ ] Construct Algolia URL for comments using arguments.
-  - [ ] Use `Workspace` with `try...catch`.
-  - [ ] Check `response.ok`, log errors if not OK.
-  - [ ] Parse JSON response.
-  - [ ] Map `hits` to `Comment` objects, extracting required fields.
-  - [ ] Filter out comments with null/empty `comment_text`.
-  - [ ] Limit results to `maxComments`.
-  - [ ] Return array of `Comment` objects (or handle error case).
-- [ ] Export functions and types as needed.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Write unit tests for `src/clients/algoliaHNClient.ts`. [919]
-  - Mock the native `Workspace` function (e.g., using `jest.spyOn(global, 'fetch')`). [918]
-  - Test `WorkspaceTopStories`: Provide mock successful responses (valid JSON matching Algolia structure [521-523]) and verify correct parsing, mapping to `Story` objects [171], and `hnUrl` construction. Test with missing `url` field. Test mock error responses (network error, non-OK status) and verify error logging [174] and return value.
-  - Test `WorkspaceCommentsForStory`: Provide mock successful responses [524-525] and verify correct parsing, mapping to `Comment` objects, filtering of empty comments, and limiting by `maxComments` [172]. Test mock error responses and verify logging [174].
-  - Verify `Workspace` was called with the correct URLs and parameters [171, 172].
-- **Integration Tests:** N/A for this client module itself, but it will be used in pipeline integration tests later. [921]
-- **Manual/CLI Verification:** Tested indirectly via Story 2.2 execution and directly via Story 2.4 stage runner. [912]
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Any notes about implementation choices, difficulties, or follow-up needed}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.2.story.md**
-
-```markdown
-# Story 2.2: Integrate HN Data Fetching into Main Workflow
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1. [176]
-
-**Context:** This story connects the HN API client created in Story 2.1 to the main application entry point (`src/index.ts`) established in Epic 1 (Story 1.3). It modifies the main execution flow to call the client functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) after the initial setup (logger, config, output directory). It uses the `MAX_COMMENTS_PER_STORY` configuration value loaded in Story 1.2. The fetched data (stories and their associated comments) is held in memory at the end of this stage. [46, 77]
-
-## Detailed Requirements
-
-- Modify the main execution flow in `src/index.ts` (or a main async function called by it, potentially moving logic to `src/core/pipeline.ts` as suggested by `ARCH` [46, 53] and `PS` [818]). **Recommendation:** Create `src/core/pipeline.ts` and a `runPipeline` async function, then call this function from `src/index.ts`.
-- Import the `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`) from Story 2.1. [177]
-- Import the configuration module (`src/utils/config.ts`) to access `MAX_COMMENTS_PER_STORY`. [177, 563] Also import the logger.
-- In the main pipeline function, after the Epic 1 setup (config load, logger init, output dir creation):
-  - Call `await fetchTopStories()`. [178]
-  - Log the number of stories fetched (e.g., "Fetched X stories."). [179] Use the logger from Story 1.4.
-  - Retrieve the `MAX_COMMENTS_PER_STORY` value from the config module. Ensure it's parsed as a number. Provide a default if necessary (e.g., 50, matching `ENV` [564]).
-  - Iterate through the array of fetched `Story` objects. [179]
-  - For each `Story`:
-    - Log progress (e.g., "Fetching up to Y comments for story {storyId}..."). [182]
-    - Call `await fetchCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY` value. [180]
-    - Store the fetched comments (the returned `Comment[]`) within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` type/object). [181] Augment the `Story` type definition in `src/types/hn.ts`. [512]
-- Ensure errors from the client functions are handled appropriately (e.g., log error and potentially skip comment fetching for that story).
-
-## Acceptance Criteria (ACs)
-
-- AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story using the `algoliaHNClient`. [183]
-- AC2: Logs (via logger) clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories. [184]
-- AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config, parsed as a number, and used in the calls to `WorkspaceCommentsForStory`. [185]
-- AC4: After successful execution (before persistence in Story 2.3), `Story` objects held in memory contain a `comments` property populated with an array of fetched `Comment` objects. [186] (Verification via debugger or temporary logging).
-- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `comments: Comment[]` field. [512]
-- AC6: (If implemented) Core logic is moved to `src/core/pipeline.ts` and called from `src/index.ts`. [818]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/core/pipeline.ts` (recommended).
-  - Files to Modify: `src/index.ts`, `src/types/hn.ts`.
-  - _(Hint: See `docs/project-structure.md` [818, 821, 822])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Uses `algoliaHNClient` (Story 2.1), `config` (Story 1.2), `logger` (Story 1.4).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `algoliaHNClient.fetchTopStories()` and `algoliaHNClient.fetchCommentsForStory()`.
-- **Data Structures:**
-  - Augment `Story` interface in `src/types/hn.ts` to include `comments: Comment[]`. [512]
-  - Manipulates arrays of `Story` and `Comment` objects in memory.
-  - _(Hint: See `docs/data-models.md` [500-517])._
-- **Environment Variables:**
-  - Reads `MAX_COMMENTS_PER_STORY` via `config.ts`. [177, 563]
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Use `async/await` for calling client functions.
-  - Structure fetching logic cleanly (e.g., within a loop).
-  - Use the logger for progress and error reporting. [182, 184]
-  - Consider putting the main loop logic inside the `runPipeline` function in `src/core/pipeline.ts`.
-
-## Tasks / Subtasks
-
-- [ ] (Recommended) Create `src/core/pipeline.ts` and define an async `runPipeline` function.
-- [ ] Modify `src/index.ts` to import and call `runPipeline`. Move existing setup logic (logger init, config load, dir creation) into `runPipeline` or ensure it runs before it.
-- [ ] In `pipeline.ts` (or `index.ts`), import `WorkspaceTopStories`, `WorkspaceCommentsForStory` from `algoliaHNClient`.
-- [ ] Import `config` and `logger`.
-- [ ] Call `WorkspaceTopStories` after initial setup. Log count.
-- [ ] Retrieve `MAX_COMMENTS_PER_STORY` from `config`, ensuring it's a number.
-- [ ] Update `Story` type in `src/types/hn.ts` to include `comments: Comment[]`.
-- [ ] Loop through the fetched stories:
-  - [ ] Log comment fetching start for the story ID.
-  - [ ] Call `WorkspaceCommentsForStory` with `storyId` and `maxComments`.
-  - [ ] Handle potential errors from the client function call.
-  - [ ] Assign the returned comments array to the `comments` property of the current story object.
-- [ ] Add temporary logging or use debugger to verify stories in memory contain comments (AC4).
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - If logic is moved to `src/core/pipeline.ts`, unit test `runPipeline`. [916]
-  - Mock `algoliaHNClient` functions (`WorkspaceTopStories`, `WorkspaceCommentsForStory`). [918]
-  - Mock `config` to provide `MAX_COMMENTS_PER_STORY`.
-  - Mock `logger`.
-  - Verify `WorkspaceTopStories` is called once.
-  - Verify `WorkspaceCommentsForStory` is called for each story returned by the mocked `WorkspaceTopStories`, and that it receives the correct `storyId` and `maxComments` value from config [185].
-  - Verify the results from mocked `WorkspaceCommentsForStory` are correctly assigned to the `comments` property of the story objects.
-- **Integration Tests:**
-  - Could have an integration test for the fetch stage that uses the real `algoliaHNClient` (or a lightly mocked version checking calls) and verifies the in-memory data structure, but this is largely covered by the stage runner (Story 2.4). [921]
-- **Manual/CLI Verification:**
-  - Run `npm run dev`.
-  - Check logs for fetching stories and comments messages [184].
-  - Use debugger or temporary `console.log` in the pipeline code to inspect a story object after the loop and confirm its `comments` property is populated [186].
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Logic moved to src/core/pipeline.ts. Verified in-memory data structure.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.3.story.md**
-
-```markdown
-# Story 2.3: Persist Fetched HN Data Locally
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging. [187]
-
-**Context:** This story follows Story 2.2 where HN data (stories with comments) was fetched and stored in memory. Now, this data needs to be saved to the local filesystem. It uses the date-stamped output directory created in Epic 1 (Story 1.4) and writes one JSON file per story, containing the story metadata and its comments. This persisted data (`{storyId}_data.json`) is the input for subsequent stages (Scraping - Epic 3, Summarization - Epic 4, Email Assembly - Epic 5). [48, 734, 735]
-
-## Detailed Requirements
-
-- Define a consistent JSON structure for the output file content. [188] Example from `docs/data-models.md` [539]: `{ storyId: "...", title: "...", articleUrl: "...", hnUrl: "...", points: ..., numComments: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", commentText: "...", author: "...", createdAt: "...", ... }, ...] }`. Include a timestamp (`WorkspaceedAt`) for when the data was fetched/saved. [190]
-- Import Node.js `fs` (specifically `writeFileSync`) and `path` modules in the pipeline module (`src/core/pipeline.ts` or `src/index.ts`). [190] Import `date-fns` or use `new Date().toISOString()` for timestamp.
-- In the main workflow (`pipeline.ts`), within the loop iterating through stories (immediately after comments have been fetched and added to the story object in Story 2.2): [191]
-  - Get the full path to the date-stamped output directory (this path should be determined/passed from the initial setup logic from Story 1.4). [191]
-  - Generate the current timestamp in ISO 8601 format (e.g., `new Date().toISOString()`) and add it to the story object as `WorkspaceedAt`. [190] Update `Story` type in `src/types/hn.ts`. [516]
-  - Construct the filename for the story's data: `{storyId}_data.json`. [192]
-  - Construct the full file path using `path.join()`. [193]
-  - Prepare the data object to be saved, matching the defined JSON structure (including `storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`).
-  - Serialize the prepared story data object to a JSON string using `JSON.stringify(storyData, null, 2)` for readability. [194]
-  - Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling around the file write. [195]
-  - Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing. [196]
-
-## Acceptance Criteria (ACs)
-
-- AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json` (assuming 10 stories were fetched successfully). [197]
-- AC2: Each JSON file contains valid JSON representing a single story object, including its metadata (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`), a `WorkspaceedAt` ISO timestamp, and an array of its fetched `comments`, matching the structure defined in `docs/data-models.md` [538-540]. [198]
-- AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`. [199]
-- AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors. [200]
-- AC5: The `Story` type definition in `src/types/hn.ts` is updated to include the `WorkspaceedAt: string` field. [516]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Modify: `src/core/pipeline.ts` (or `src/index.ts`), `src/types/hn.ts`.
-  - _(Hint: See `docs/project-structure.md` [818, 821, 822])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Native `fs` module (`writeFileSync`) [190].
-  - Native `path` module (`join`) [193].
-  - `JSON.stringify` [194].
-  - Uses `logger` (Story 1.4).
-  - Uses output directory path created in Story 1.4 logic.
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - `fs.writeFileSync(filePath, jsonDataString, 'utf-8')`. [195]
-- **Data Structures:**
-  - Uses `Story` and `Comment` types from `src/types/hn.ts`.
-  - Augment `Story` type to include `WorkspaceedAt: string`. [516]
-  - Creates JSON structure matching `{storyId}_data.json` schema in `docs/data-models.md`. [538-540]
-  - _(Hint: See `docs/data-models.md`)._
-- **Environment Variables:**
-  - N/A directly, but relies on `OUTPUT_DIR_PATH` being available from config (Story 1.2) used by the directory creation logic (Story 1.4).
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Use `try...catch` for `writeFileSync` calls. [195]
-  - Use `JSON.stringify` with indentation (`null, 2`) for readability. [194]
-  - Log success/failure clearly using the logger. [196]
-
-## Tasks / Subtasks
-
-- [ ] In `pipeline.ts` (or `index.ts`), import `fs` and `path`.
-- [ ] Update `Story` type in `src/types/hn.ts` to include `WorkspaceedAt: string`.
-- [ ] Ensure the full path to the date-stamped output directory is available within the story processing loop.
-- [ ] Inside the loop (after comments are fetched for a story):
-  - [ ] Get the current ISO timestamp (`new Date().toISOString()`).
-  - [ ] Add the timestamp to the story object as `WorkspaceedAt`.
-  - [ ] Construct the output filename: `{storyId}_data.json`.
-  - [ ] Construct the full file path using `path.join(outputDirPath, filename)`.
-  - [ ] Create the data object matching the specified JSON structure, including comments.
-  - [ ] Serialize the data object using `JSON.stringify(data, null, 2)`.
-  - [ ] Use `try...catch` block:
-    - [ ] Inside `try`: Call `fs.writeFileSync(fullPath, jsonString, 'utf-8')`.
-    - [ ] Inside `try`: Log success message with filename.
-    - [ ] Inside `catch`: Log file writing error with filename.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Testing file system interactions directly in unit tests can be brittle. [918]
-  - Focus unit tests on the data preparation logic: ensure the object created before `JSON.stringify` has the correct structure (`storyId`, `title`, `articleUrl`, `hnUrl`, `points`, `numComments`, `WorkspaceedAt`, `comments`) based on a sample input `Story` object. [920]
-  - Verify the `WorkspaceedAt` timestamp is added correctly.
-- **Integration Tests:** [921]
-  - Could test the file writing aspect using `mock-fs` or actual file system writes within a temporary directory (created during setup, removed during teardown). [924]
-  - Verify that the correct filename is generated and the content written to the mock/temporary file matches the expected JSON structure [538-540] and content.
-- **Manual/CLI Verification:** [912]
-  - Run `npm run dev`.
-  - Inspect the `output/YYYY-MM-DD/` directory (use current date).
-  - Verify 10 files named `{storyId}_data.json` exist (AC1).
-  - Open a few files, visually inspect the JSON structure, check for all required fields (metadata, `WorkspaceedAt`, `comments` array), and verify comment count <= `MAX_COMMENTS_PER_STORY` (AC2, AC3).
-  - Check console logs for success messages for file writing or any errors (AC4).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Files saved successfully in ./output/YYYY-MM-DD/ directory.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/2.4.story.md**
-
-```markdown
-# Story 2.4: Implement Stage Testing Utility for HN Fetching
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a separate, executable script that _only_ performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline. [201]
-
-**Context:** This story addresses the PRD requirement [736] for stage-specific testing utilities [764]. It creates a standalone Node.js script (`src/stages/fetch_hn_data.ts`) that replicates the core logic of Stories 2.1, 2.2 (partially), and 2.3. This script will initialize necessary components (logger, config), call the `algoliaHNClient` to fetch stories and comments, and persist the results to the date-stamped output directory, just like the main pipeline does up to this point. This allows isolated testing of the Algolia API interaction and data persistence without running subsequent scraping, summarization, or emailing stages. [57, 62, 912]
-
-## Detailed Requirements
-
-- Create a new standalone script file: `src/stages/fetch_hn_data.ts`. [202]
-- This script should perform the essential setup required _for this stage_:
-  - Initialize the logger utility (from Story 1.4). [203]
-  - Load configuration using the config utility (from Story 1.2) to get `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH`. [203]
-  - Determine the current date ('YYYY-MM-DD') using the utility from Story 1.4. [203]
-  - Construct the date-stamped output directory path. [203]
-  - Ensure the output directory exists (create it recursively if not, reusing logic/utility from Story 1.4). [203]
-- The script should then execute the core logic of fetching and persistence:
-  - Import and use `algoliaHNClient.fetchTopStories` and `algoliaHNClient.fetchCommentsForStory` (from Story 2.1). [204]
-  - Import `fs` and `path`.
-  - Replicate the fetch loop logic from Story 2.2 (fetch stories, then loop to fetch comments for each using loaded `MAX_COMMENTS_PER_STORY` limit). [204]
-  - Replicate the persistence logic from Story 2.3 (add `WorkspaceedAt` timestamp, prepare data object, `JSON.stringify`, `fs.writeFileSync` to `{storyId}_data.json` in the date-stamped directory). [204]
-- The script should log its progress (e.g., "Starting HN data fetch stage...", "Fetching stories...", "Fetching comments for story X...", "Saving data for story X...") using the logger utility. [205]
-- Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`. [206]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The file `src/stages/fetch_hn_data.ts` exists. [207]
-- AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section. [208]
-- AC3: Running `npm run stage:fetch` executes successfully, performing only the setup (logger, config, output dir), fetch (stories, comments), and persist steps (to JSON files). [209]
-- AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (up to the end of Epic 2 functionality). [210]
-- AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages (scraping, summarizing, emailing). [211]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/stages/fetch_hn_data.ts`.
-  - Files to Modify: `package.json`.
-  - _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], `ts-node` (via `npm run` script).
-  - Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), directory creation logic (Story 1.4), `algoliaHNClient` (Story 2.1), `fs`/`path` (Story 2.3).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `algoliaHNClient` functions.
-  - Uses `fs.writeFileSync`.
-- **Data Structures:**
-  - Uses `Story`, `Comment` types.
-  - Generates `{storyId}_data.json` files [538-540].
-  - _(Hint: See `docs/data-models.md`)._
-- **Environment Variables:**
-  - Reads `MAX_COMMENTS_PER_STORY` and `OUTPUT_DIR_PATH` via `config.ts`.
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Structure the script clearly (setup, fetch, persist).
-  - Use `async/await`.
-  - Use logger extensively for progress indication. [205]
-  - Consider wrapping the main logic in an `async` IIFE (Immediately Invoked Function Expression) or a main function call.
-
-## Tasks / Subtasks
-
-- [ ] Create `src/stages/fetch_hn_data.ts`.
-- [ ] Add imports for logger, config, date util, `algoliaHNClient`, `fs`, `path`.
-- [ ] Implement setup logic: initialize logger, load config, get output dir path, ensure directory exists.
-- [ ] Implement main fetch logic:
-  - [ ] Call `WorkspaceTopStories`.
-  - [ ] Get `MAX_COMMENTS_PER_STORY` from config.
-  - [ ] Loop through stories:
-    - [ ] Call `WorkspaceCommentsForStory`.
-    - [ ] Add comments to story object.
-    - [ ] Add `WorkspaceedAt` timestamp.
-    - [ ] Prepare data object for saving.
-    - [ ] Construct full file path for `{storyId}_data.json`.
-    - [ ] Serialize and write to file using `fs.writeFileSync` within `try...catch`.
-    - [ ] Log progress/success/errors.
-- [ ] Add script `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"` to `package.json`.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** Unit tests for the underlying components (logger, config, client, utils) should already exist from previous stories. Unit testing the stage script itself might have limited value beyond checking basic setup calls if the core logic is just orchestrating tested components. [915]
-- **Integration Tests:** N/A specifically for the script, as it _is_ an integration test itself. [921]
-- **Manual/CLI Verification (Primary Test Method for this Story):** [912, 927]
-  - Run `npm run stage:fetch`. [209]
-  - Verify successful execution without errors.
-  - Check console logs for messages specific to fetching and persisting [211].
-  - Inspect the `output/YYYY-MM-DD/` directory and verify the content of the generated `{storyId}_data.json` files match expectations (similar to verification for Story 2.3) [210].
-  - Modify `package.json` to add the script (AC2).
-- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Stage runner script created and tested successfully. package.json updated.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-## **End of Report for Epic 2**

V2-FULL-DEMO-WALKTHROUGH/epic-3-stories-demo.md

@@ -1,486 +0,0 @@
-Okay, remaining in **SM Mode**.
-
-Generating the stories for **Epic 3: Article Scraping & Persistence**. This assumes that Epic 1 (project setup, config, logging, output dir) and Epic 2 (HN client implementation, data fetching integration, and local persistence of `{storyId}_data.json` files) are complete.
-
----
-
-## **Stories Report: Epic 3**
-
-**File: ai/stories/3.1.story.md**
-
-```markdown
-# Story 3.1: Implement Basic Article Scraper Module
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization. [220]
-
-**Context:** This story introduces the article scraping capability. It creates a dedicated module (`src/scraper/articleScraper.ts`) responsible for fetching content from external article URLs (found in the `{storyId}_data.json` files from Epic 2) and extracting plain text. It emphasizes using native `Workspace` and a simple extraction library (`@extractus/article-extractor` is recommended [222, 873]), and crucially, handling failures robustly (timeouts, non-HTML content, extraction errors) as required by the PRD [723, 724, 741]. This module will be used by the main pipeline (Story 3.2) and the stage tester (Story 3.4). [47, 55, 60, 63, 65]
-
-## Detailed Requirements
-
-- Create a new module: `src/scraper/articleScraper.ts`. [221]
-- Add `@extractus/article-extractor` dependency: `npm install @extractus/article-extractor --save-prod`. [222, 223, 873]
-- Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module. [223, 224]
-- Inside the function:
-  - Use native `Workspace` [749] to retrieve content from the `url`. [224] Set a reasonable timeout (e.g., 15 seconds via `AbortSignal.timeout()`, configure via `SCRAPE_TIMEOUT_MS` [615] if needed). Include a `User-Agent` header (e.g., `"BMadHackerDigest/0.1"` or configurable via `SCRAPER_USER_AGENT` [629]). [225]
-  - Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`. Log error using logger (from Story 1.4) and return `null`. [226]
-  - Check the `response.ok` status. If not okay, log error (including status code) and return `null`. [226, 227]
-  - Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`. [227, 228]
-  - If HTML is received (`response.text()`), attempt to extract the main article text using `@extractus/article-extractor`. [229]
-  - Wrap the extraction logic (`await articleExtractor.extract(htmlContent)`) in a `try...catch` to handle library-specific errors. Log error and return `null` on failure. [230]
-  - Return the extracted plain text (`article.content`) if successful and not empty. Ensure it's just text, not HTML markup. [231]
-  - Return `null` if extraction fails or results in empty content. [232]
-  - Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-OK status:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text for {url}") using the logger utility. [233]
-- Define TypeScript types/interfaces as needed (though `article-extractor` types might suffice). [234]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The `src/scraper/articleScraper.ts` module exists and exports the `scrapeArticle` function. [234]
-- AC2: The `@extractus/article-extractor` library is added to `dependencies` in `package.json` and `package-lock.json` is updated. [235]
-- AC3: `scrapeArticle` uses native `Workspace` with a timeout (default or configured) and a User-Agent header. [236]
-- AC4: `scrapeArticle` correctly handles fetch errors (network, timeout), non-OK responses, and non-HTML content types by logging the specific reason and returning `null`. [237]
-- AC5: `scrapeArticle` uses `@extractus/article-extractor` to attempt text extraction from valid HTML content fetched via `response.text()`. [238]
-- AC6: `scrapeArticle` returns the extracted plain text string on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result). [239]
-- AC7: Relevant logs are produced using the logger for success, different failure modes, and errors encountered during the process. [240]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/scraper/articleScraper.ts`.
-  - Files to Modify: `package.json`, `package-lock.json`. Add optional env vars to `.env.example`.
-  - _(Hint: See `docs/project-structure.md` [819] for scraper location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], Native `Workspace` API [863].
-  - `@extractus/article-extractor` library. [873]
-  - Uses `logger` utility (Story 1.4).
-  - Uses `config` utility (Story 1.2) if implementing configurable timeout/user-agent.
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Native `Workspace(url, { signal: AbortSignal.timeout(timeoutMs), headers: { 'User-Agent': userAgent } })`. [225]
-  - Check `response.ok`, `response.headers.get('Content-Type')`. [227, 228]
-  - Get body as text: `await response.text()`. [229]
-  - `@extractus/article-extractor`: `import articleExtractor from '@extractus/article-extractor'; const article = await articleExtractor.extract(htmlContent); return article?.content || null;` [229, 231]
-- **Data Structures:**
-  - Function signature: `scrapeArticle(url: string): Promise<string | null>`. [224]
-  - Uses `article` object returned by extractor.
-  - _(Hint: See `docs/data-models.md` [498-547])._
-- **Environment Variables:**
-  - Optional: `SCRAPE_TIMEOUT_MS` (default e.g., 15000). [615]
-  - Optional: `SCRAPER_USER_AGENT` (default e.g., "BMadHackerDigest/0.1"). [629]
-  - Load via `config.ts` if used.
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Use `async/await`.
-  - Implement comprehensive `try...catch` blocks for `Workspace` and extraction. [226, 230]
-  - Log errors and reasons for returning `null` clearly. [233]
-
-## Tasks / Subtasks
-
-- [ ] Run `npm install @extractus/article-extractor --save-prod`.
-- [ ] Create `src/scraper/articleScraper.ts`.
-- [ ] Import logger, (optionally config), and `articleExtractor`.
-- [ ] Define the `scrapeArticle` async function accepting a `url`.
-- [ ] Implement `try...catch` for the entire fetch/parse logic. Log error and return `null` in `catch`.
-- [ ] Inside `try`:
-  - [ ] Define timeout (default or from config).
-  - [ ] Define User-Agent (default or from config).
-  - [ ] Call native `Workspace` with URL, timeout signal, and User-Agent header.
-  - [ ] Check `response.ok`. If not OK, log status and return `null`.
-  - [ ] Check `Content-Type` header. If not HTML, log type and return `null`.
-  - [ ] Get HTML content using `response.text()`.
-  - [ ] Implement inner `try...catch` for extraction:
-    - [ ] Call `await articleExtractor.extract(htmlContent)`.
-    - [ ] Check if result (`article?.content`) is valid text. If yes, log success and return text.
-    - [ ] If extraction failed or content is empty, log reason and return `null`.
-    - [ ] In `catch` block for extraction, log error and return `null`.
-- [ ] Add optional env vars `SCRAPE_TIMEOUT_MS` and `SCRAPER_USER_AGENT` to `.env.example`.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Write unit tests for `src/scraper/articleScraper.ts`. [919]
-  - Mock native `Workspace`. Test different scenarios:
-    - Successful fetch (200 OK, HTML content type) -> Mock `articleExtractor` success -> Verify returned text [239].
-    - Successful fetch -> Mock `articleExtractor` failure/empty content -> Verify `null` return and logs [239, 240].
-    - Fetch returns non-OK status (e.g., 404, 500) -> Verify `null` return and logs [237, 240].
-    - Fetch returns non-HTML content type -> Verify `null` return and logs [237, 240].
-    - Fetch throws network error/timeout -> Verify `null` return and logs [237, 240].
-  - Mock `@extractus/article-extractor` to simulate success and failure cases. [918]
-  - Verify `Workspace` is called with the correct URL, User-Agent, and timeout signal [236].
-- **Integration Tests:** N/A for this module itself. [921]
-- **Manual/CLI Verification:** Tested indirectly via Story 3.2 execution and directly via Story 3.4 stage runner. [912]
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Implemented scraper module with @extractus/article-extractor and robust error handling.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/3.2.story.md**
-
-```markdown
-# Story 3.2: Integrate Article Scraping into Main Workflow
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to integrate the article scraper into the main workflow (`src/core/pipeline.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data. [241]
-
-**Context:** This story connects the scraper module (`articleScraper.ts` from Story 3.1) into the main application pipeline (`src/core/pipeline.ts`) developed in Epic 2. It modifies the main loop over the fetched stories (which contain data loaded in Story 2.2) to include a call to `scrapeArticle` for stories that have an article URL. The result (scraped text or null) is then stored in memory, associated with the story object. [47, 78, 79]
-
-## Detailed Requirements
-
-- Modify the main execution flow in `src/core/pipeline.ts` (assuming logic moved here in Story 2.2). [242]
-- Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`. [243] Import the logger.
-- Within the main loop iterating through the fetched `Story` objects (after comments are fetched in Story 2.2 and before persistence in Story 2.3):
-  - Check if `story.articleUrl` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient. [243, 244]
-  - If the URL is missing or invalid, log a warning using the logger ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next step for this story (e.g., summarization in Epic 4, or persistence in Story 3.3). Set an internal placeholder for scraped content to `null`. [245]
-  - If a valid URL exists:
-    - Log ("Attempting to scrape article for story {storyId} from {story.articleUrl}"). [246]
-    - Call `await scrapeArticle(story.articleUrl)`. [247]
-    - Store the result (the extracted text string or `null`) in memory, associated with the story object. Define/add property `articleContent: string | null` to the `Story` type in `src/types/hn.ts`. [247, 513]
-    - Log the outcome clearly using the logger (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}"). [248]
-
-## Acceptance Criteria (ACs)
-
-- AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid `articleUrl`s within the main pipeline loop. [249]
-- AC2: Stories with missing or invalid `articleUrl`s are skipped by the scraping step, and a corresponding warning message is logged via the logger. [250]
-- AC3: For stories with valid URLs, the `scrapeArticle` function from `src/scraper/articleScraper.ts` is called with the correct URL. [251]
-- AC4: Logs (via logger) clearly indicate the start ("Attempting to scrape...") and the success/failure outcome of the scraping attempt for each relevant story. [252]
-- AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed. [253] (Verify via debugger/logging).
-- AC6: The `Story` type definition in `src/types/hn.ts` is updated to include the `articleContent: string | null` field. [513]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Modify: `src/core/pipeline.ts`, `src/types/hn.ts`.
-  - _(Hint: See `docs/project-structure.md` [818, 821])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Uses `articleScraper.scrapeArticle` (Story 3.1), `logger` (Story 1.4).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `scrapeArticle(url)`.
-- **Data Structures:**
-  - Operates on `Story[]` fetched in Epic 2.
-  - Augment `Story` interface in `src/types/hn.ts` to include `articleContent: string | null`. [513]
-  - Checks `story.articleUrl`.
-  - _(Hint: See `docs/data-models.md` [506-517])._
-- **Environment Variables:**
-  - N/A directly, but `scrapeArticle` might use them (Story 3.1).
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Perform the URL check before calling the scraper. [244]
-  - Clearly log skipping, attempt, success, failure for scraping. [245, 246, 248]
-  - Ensure the `articleContent` property is always set (either to the result string or explicitly to `null`).
-
-## Tasks / Subtasks
-
-- [ ] Update `Story` type in `src/types/hn.ts` to include `articleContent: string | null`.
-- [ ] Modify the main loop in `src/core/pipeline.ts` where stories are processed.
-- [ ] Import `scrapeArticle` from `src/scraper/articleScraper.ts`.
-- [ ] Import `logger`.
-- [ ] Inside the loop (after comment fetching, before persistence steps):
-  - [ ] Check if `story.articleUrl` exists and starts with `http`.
-  - [ ] If invalid/missing:
-    - [ ] Log warning message.
-    - [ ] Set `story.articleContent = null`.
-  - [ ] If valid:
-    - [ ] Log attempt message.
-    - [ ] Call `const scrapedContent = await scrapeArticle(story.articleUrl)`.
-    - [ ] Set `story.articleContent = scrapedContent`.
-    - [ ] Log success (if `scrapedContent` is not null) or failure (if `scrapedContent` is null).
-- [ ] Add temporary logging or use debugger to verify `articleContent` property in story objects (AC5).
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Unit test the modified pipeline logic in `src/core/pipeline.ts`. [916]
-  - Mock the `scrapeArticle` function. [918]
-  - Provide mock `Story` objects with and without valid `articleUrl`s.
-  - Verify that `scrapeArticle` is called only for stories with valid URLs [251].
-  - Verify that the correct URL is passed to `scrapeArticle`.
-  - Verify that the return value (mocked text or mocked null) from `scrapeArticle` is correctly assigned to the `story.articleContent` property [253].
-  - Verify that appropriate logs (skip warning, attempt, success/fail) are called based on the URL validity and mocked `scrapeArticle` result [250, 252].
-- **Integration Tests:** Less emphasis here; Story 3.4 provides better integration testing for scraping. [921]
-- **Manual/CLI Verification:** [912]
-  - Run `npm run dev`.
-  - Check console logs for "Attempting to scrape...", "Successfully scraped...", "Failed to scrape...", and "Skipping scraping..." messages [250, 252].
-  - Use debugger or temporary logging to inspect `story.articleContent` values during or after the pipeline run [253].
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Integrated scraper call into pipeline. Updated Story type. Verified logic for handling valid/invalid URLs.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/3.3.story.md**
-
-```markdown
-# Story 3.3: Persist Scraped Article Text Locally
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage. [254]
-
-**Context:** This story adds the persistence step for the article content scraped in Story 3.2. Following a successful scrape (where `story.articleContent` is not null), this logic writes the plain text content to a `.txt` file (`{storyId}_article.txt`) within the date-stamped output directory created in Epic 1. This ensures the scraped text is available for the next stage (Summarization - Epic 4) even if the main script is run in stages or needs to be restarted. No file should be created if scraping failed or was skipped. [49, 734, 735]
-
-## Detailed Requirements
-
-- Import Node.js `fs` (`writeFileSync`) and `path` modules if not already present in `src/core/pipeline.ts`. [255] Import logger.
-- In the main workflow (`src/core/pipeline.ts`), within the loop processing each story, _after_ the scraping attempt (Story 3.2) is complete: [256]
-  - Check if `story.articleContent` is a non-null, non-empty string.
-  - If yes (scraping was successful and yielded content):
-    - Retrieve the full path to the current date-stamped output directory (available from setup). [256]
-    - Construct the filename: `{storyId}_article.txt`. [257]
-    - Construct the full file path using `path.join()`. [257]
-    - Get the successfully scraped article text string (`story.articleContent`). [258]
-    - Use `fs.writeFileSync(fullPath, story.articleContent, 'utf-8')` to save the text to the file. [259] Wrap this call in a `try...catch` block for file system errors. [260]
-    - Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered, using the logger. [260]
-  - If `story.articleContent` is null or empty (scraping skipped or failed), ensure _no_ `_article.txt` file is created for this story. [261]
-
-## Acceptance Criteria (ACs)
-
-- AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files _only_ for those stories where `scrapeArticle` (from Story 3.1) succeeded and returned non-empty text content during the pipeline run (Story 3.2). [262]
-- AC2: The name of each article text file is `{storyId}_article.txt`. [263]
-- AC3: The content of each existing `_article.txt` file is the plain text string stored in `story.articleContent`. [264]
-- AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors. [265]
-- AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful and returned content. [266]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Modify: `src/core/pipeline.ts`.
-  - _(Hint: See `docs/project-structure.md` [818])._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851].
-  - Native `fs` module (`writeFileSync`). [259]
-  - Native `path` module (`join`). [257]
-  - Uses `logger` (Story 1.4).
-  - Uses output directory path (from Story 1.4 logic).
-  - Uses `story.articleContent` populated in Story 3.2.
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - `fs.writeFileSync(fullPath, articleContentString, 'utf-8')`. [259]
-- **Data Structures:**
-  - Checks `story.articleContent` (string | null).
-  - Defines output file format `{storyId}_article.txt` [541].
-  - _(Hint: See `docs/data-models.md` [506-517, 541])._
-- **Environment Variables:**
-  - Relies on `OUTPUT_DIR_PATH` being available (from Story 1.2/1.4).
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Place the file writing logic immediately after the scraping result is known for a story.
-  - Use a clear `if (story.articleContent)` check. [256]
-  - Use `try...catch` around `fs.writeFileSync`. [260]
-  - Log success/failure clearly. [260]
-
-## Tasks / Subtasks
-
-- [ ] In `src/core/pipeline.ts`, ensure `fs` and `path` are imported. Ensure logger is imported.
-- [ ] Ensure the output directory path is available within the story processing loop.
-- [ ] Inside the loop, after `story.articleContent` is set (from Story 3.2):
-  - [ ] Add an `if (story.articleContent)` condition.
-  - [ ] Inside the `if` block:
-    - [ ] Construct filename: `{storyId}_article.txt`.
-    - [ ] Construct full path using `path.join`.
-    - [ ] Implement `try...catch`:
-      - [ ] `try`: Call `fs.writeFileSync(fullPath, story.articleContent, 'utf-8')`.
-      - [ ] `try`: Log success message.
-      - [ ] `catch`: Log error message.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** [915]
-  - Difficult to unit test filesystem writes effectively. Focus on testing the _conditional logic_ within the pipeline function. [918]
-  - Mock `fs.writeFileSync`. Provide mock `Story` objects where `articleContent` is sometimes a string and sometimes null.
-  - Verify `fs.writeFileSync` is called _only when_ `articleContent` is a non-empty string. [262]
-  - Verify it's called with the correct path (`path.join(outputDir, storyId + '_article.txt')`) and content (`story.articleContent`). [263, 264]
-- **Integration Tests:** [921]
-  - Use `mock-fs` or temporary directory setup/teardown. [924]
-  - Run the pipeline segment responsible for scraping (mocked) and saving.
-  - Verify that `.txt` files are created only for stories where the mocked scraper returned text.
-  - Verify file contents match the mocked text.
-- **Manual/CLI Verification:** [912]
-  - Run `npm run dev`.
-  - Inspect the `output/YYYY-MM-DD/` directory.
-  - Check which `{storyId}_article.txt` files exist. Compare this against the console logs indicating successful/failed scraping attempts for corresponding story IDs. Verify files only exist for successful scrapes (AC1, AC5).
-  - Check filenames are correct (AC2).
-  - Open a few existing `.txt` files and spot-check the content (AC3).
-  - Check logs for file saving success/error messages (AC4).
-- _(Hint: See `docs/testing-strategy.md` [907-950] for the overall approach)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Added logic to save article text conditionally. Verified files are created only on successful scrape.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-**File: ai/stories/3.4.story.md**
-
-```markdown
-# Story 3.4: Implement Stage Testing Utility for Scraping
-
-**Status:** Draft
-
-## Goal & Context
-
-**User Story:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper. [267]
-
-**Context:** This story implements the standalone stage testing utility for Epic 3, as required by the PRD [736, 764]. It creates `src/stages/scrape_articles.ts`, which reads story data (specifically URLs) from the `{storyId}_data.json` files generated in Epic 2 (or by `stage:fetch`), calls the `scrapeArticle` function (from Story 3.1) for each URL, and persists any successfully scraped text to `{storyId}_article.txt` files (replicating Story 3.3 logic). This allows testing the scraping functionality against real websites using previously fetched story lists, without running the full pipeline or the HN fetching stage. [57, 63, 820, 912, 930]
-
-## Detailed Requirements
-
-- Create a new standalone script file: `src/stages/scrape_articles.ts`. [268]
-- Import necessary modules: `fs` (e.g., `readdirSync`, `readFileSync`, `writeFileSync`, `existsSync`, `statSync`), `path`, `logger` (Story 1.4), `config` (Story 1.2), `scrapeArticle` (Story 3.1), date util (Story 1.4). [269]
-- The script should:
-  - Initialize the logger. [270]
-  - Load configuration (to get `OUTPUT_DIR_PATH`). [271]
-  - Determine the target date-stamped directory path (e.g., using current date via date util, or potentially allow override via CLI arg later - current date default is fine for now). [271] Ensure this base output directory exists. Log the target directory.
-  - Check if the target date-stamped directory exists. If not, log an error and exit ("Directory {path} not found. Run fetch stage first?").
-  - Read the directory contents and identify all files ending with `_data.json`. [272] Use `fs.readdirSync` and filter.
-  - For each `_data.json` file found:
-    - Construct the full path and read its content using `fs.readFileSync`. [273]
-    - Parse the JSON content. Handle potential parse errors gracefully (log error, skip file). [273]
-    - Extract the `storyId` and `articleUrl` from the parsed data. [274]
-    - If a valid `articleUrl` exists (starts with `http`): [274]
-      - Log the attempt: "Attempting scrape for story {storyId} from {url}...".
-      - Call `await scrapeArticle(articleUrl)`. [274]
-      - If scraping succeeds (returns a non-null string):
-        - Construct the output filename `{storyId}_article.txt`. [275]
-        - Construct the full output path. [275]
-        - Save the text to the file using `fs.writeFileSync` (replicating logic from Story 3.3, including try/catch and logging). [275] Overwrite if the file exists. [276]
-        - Log success outcome.
-      - If scraping fails (`scrapeArticle` returns null):
-        - Log failure outcome.
-    - If `articleUrl` is missing or invalid:
-      - Log skipping message.
-  - Log overall completion: "Scraping stage finished processing {N} data files.".
-- Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. [277]
-
-## Acceptance Criteria (ACs)
-
-- AC1: The file `src/stages/scrape_articles.ts` exists. [279]
-- AC2: The script `stage:scrape` is defined in `package.json`'s `scripts` section. [280]
-- AC3: Running `npm run stage:scrape` (assuming a date-stamped directory with `_data.json` files exists from a previous fetch run) successfully reads these JSON files. [281]
-- AC4: The script calls `scrapeArticle` for stories with valid `articleUrl`s found in the JSON files. [282]
-- AC5: The script creates or updates `{storyId}_article.txt` files in the _same_ date-stamped directory, corresponding only to successfully scraped articles. [283]
-- AC6: The script logs its actions (reading files, attempting scraping, skipping, saving results/failures) for each story ID processed based on the found `_data.json` files. [284]
-- AC7: The script operates solely based on local `_data.json` files as input and fetching from external article URLs via `scrapeArticle`; it does not call the Algolia HN API client. [285, 286]
-
-## Technical Implementation Context
-
-**Guidance:** Use the following details for implementation. Refer to the linked `docs/` files for broader context if needed.
-
-- **Relevant Files:**
-  - Files to Create: `src/stages/scrape_articles.ts`.
-  - Files to Modify: `package.json`.
-  - _(Hint: See `docs/project-structure.md` [820] for stage runner location)._
-- **Key Technologies:**
-  - TypeScript [846], Node.js 22.x [851], `ts-node`.
-  - Native `fs` module (`readdirSync`, `readFileSync`, `writeFileSync`, `existsSync`, `statSync`). [269]
-  - Native `path` module. [269]
-  - Uses `logger` (Story 1.4), `config` (Story 1.2), date util (Story 1.4), `scrapeArticle` (Story 3.1), persistence logic (Story 3.3).
-  - _(Hint: See `docs/tech-stack.md` [839-905])._
-- **API Interactions / SDK Usage:**
-  - Calls internal `scrapeArticle(url)`.
-  - Uses `fs` module extensively for reading directory, reading JSON, writing TXT.
-- **Data Structures:**
-  - Reads JSON structure from `_data.json` files [538-540]. Extracts `storyId`, `articleUrl`.
-  - Creates `{storyId}_article.txt` files [541].
-  - _(Hint: See `docs/data-models.md`)._
-- **Environment Variables:**
-  - Reads `OUTPUT_DIR_PATH` via `config.ts`. `scrapeArticle` might use others.
-  - _(Hint: See `docs/environment-vars.md` [548-638])._
-- **Coding Standards Notes:**
-  - Structure script clearly (setup, read data files, loop, process/scrape/save).
-  - Use `async/await` for `scrapeArticle`.
-  - Implement robust error handling for file IO (reading dir, reading files, parsing JSON, writing files) using `try...catch` and logging.
-  - Use logger for detailed progress reporting. [284]
-  - Wrap main logic in an async IIFE or main function.
-
-## Tasks / Subtasks
-
-- [ ] Create `src/stages/scrape_articles.ts`.
-- [ ] Add imports: `fs`, `path`, `logger`, `config`, `scrapeArticle`, date util.
-- [ ] Implement setup: Init logger, load config, get output path, get target date-stamped path.
-- [ ] Check if target date-stamped directory exists, log error and exit if not.
-- [ ] Use `fs.readdirSync` to get list of files in the target directory.
-- [ ] Filter the list to get only files ending in `_data.json`.
-- [ ] Loop through the `_data.json` filenames:
-  - [ ] Construct full path for the JSON file.
-  - [ ] Use `try...catch` for reading and parsing the JSON file:
-    - [ ] `try`: Read file (`fs.readFileSync`). Parse JSON (`JSON.parse`).
-    - [ ] `catch`: Log error (read/parse), continue to next file.
-  - [ ] Extract `storyId` and `articleUrl`.
-  - [ ] Check if `articleUrl` is valid (starts with `http`).
-  - [ ] If valid:
-    - [ ] Log attempt.
-    - [ ] Call `content = await scrapeArticle(articleUrl)`.
-    - [ ] `if (content)`:
-      - [ ] Construct `.txt` output path.
-      - [ ] Use `try...catch` to write file (`fs.writeFileSync`). Log success/error.
-    - [ ] `else`: Log scrape failure.
-  - [ ] If URL invalid: Log skip.
-- [ ] Log completion message.
-- [ ] Add `"stage:scrape": "ts-node src/stages/scrape_articles.ts"` to `package.json`.
-
-## Testing Requirements
-
-**Guidance:** Verify implementation against the ACs using the following tests.
-
-- **Unit Tests:** Difficult to unit test the entire script effectively due to heavy FS and orchestration logic. Focus on unit testing the core `scrapeArticle` module (Story 3.1) and utilities. [915]
-- **Integration Tests:** N/A for the script itself. [921]
-- **Manual/CLI Verification (Primary Test Method):** [912, 927, 930]
-  - Ensure `_data.json` files exist from `npm run stage:fetch` or `npm run dev`.
-  - Run `npm run stage:scrape`. [281]
-  - Verify successful execution.
-  - Check logs for reading files, skipping, attempting scrapes, success/failure messages, and saving messages [284].
-  - Inspect the `output/YYYY-MM-DD/` directory for newly created/updated `{storyId}_article.txt` files. Verify they correspond to stories where scraping succeeded according to logs [283, 285].
-  - Verify the script _only_ performed scraping actions based on local files (AC7).
-  - Modify `package.json` to add the script (AC2).
-- _(Hint: See `docs/testing-strategy.md` [907-950] which identifies Stage Runners as a key part of Acceptance Testing)._
-
-## Story Wrap Up (Agent Populates After Execution)
-
-- **Agent Model Used:** `<Agent Model Name/Version>`
-- **Completion Notes:** {Stage runner implemented. Reads \_data.json, calls scraper, saves \_article.txt conditionally. package.json updated.}
-- **Change Log:**
-  - Initial Draft
-```
-
----
-
-## **End of Report for Epic 3**

V2-FULL-DEMO-WALKTHROUGH/epic1.md

@@ -1,89 +0,0 @@
-# Epic 1: Project Initialization & Core Setup
-
-**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
-
-## Story List
-
-### Story 1.1: Initialize Project from Boilerplate
-
--   **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
--   **Detailed Requirements:**
-    -   Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
-    -   Initialize a git repository in the project root directory (if not already done by cloning).
-    -   Ensure the `.gitignore` file from the boilerplate is present.
-    -   Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
-    -   Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The project directory contains the files and structure from `bmad-boilerplate`.
-    -   AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
-    -   AC3: `npm run lint` command completes successfully without reporting any linting errors.
-    -   AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
-    -   AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
-    -   AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
-    -   AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
-
----
-
-### Story 1.2: Setup Environment Configuration
-
--   **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
--   **Detailed Requirements:**
-    -   Verify the `.env.example` file exists (from boilerplate).
-    -   Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
-    -   Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
-    -   Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
-    -   The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
-    -   Ensure the `.env` file is listed in `.gitignore` and is not committed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: Handle `.env` files with native node 22 support, no need for `dotenv`
-    -   AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
-    -   AC3: The `.env` file exists locally but is NOT tracked by git.
-    -   AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
-    -   AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
-
----
-
-### Story 1.3: Implement Basic CLI Entry Point & Execution
-
--   **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
--   **Detailed Requirements:**
-    -   Create the main application entry point file at `src/index.ts`.
-    -   Implement minimal code within `src/index.ts` to:
-        -   Import the configuration loading mechanism (from Story 1.2).
-        -   Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
-        -   (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
-    -   Confirm execution using boilerplate scripts.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `src/index.ts` file exists.
-    -   AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
-    -   AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
-    -   AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
-
----
-
-### Story 1.4: Setup Basic Logging and Output Directory
-
--   **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
--   **Detailed Requirements:**
-    -   Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
-    -   Refactor `src/index.ts` to use this `logger` for its startup message(s).
-    -   In `src/index.ts` (or a setup function called by it):
-        -   Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
-        -   Determine the current date in 'YYYY-MM-DD' format.
-        -   Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
-        -   Check if the base output directory exists; if not, create it.
-        -   Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
-        -   Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
--   **Acceptance Criteria (ACs):**
-    -   AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
-    -   AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
-    -   AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
-    -   AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
-    -   AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
-    -   AC6: The application exits gracefully after performing these setup steps (for now).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 1     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic1.txt

@@ -1,89 +0,0 @@
-# Epic 1: Project Initialization & Core Setup
-
-**Goal:** Initialize the project using the "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure. This provides the foundational setup for all subsequent development work.
-
-## Story List
-
-### Story 1.1: Initialize Project from Boilerplate
-
--   **User Story / Goal:** As a developer, I want to set up the initial project structure using the `bmad-boilerplate`, so that I have the standard tooling (TS, Jest, ESLint, Prettier), configurations, and scripts in place.
--   **Detailed Requirements:**
-    -   Copy or clone the contents of the `bmad-boilerplate` into the new project's root directory.
-    -   Initialize a git repository in the project root directory (if not already done by cloning).
-    -   Ensure the `.gitignore` file from the boilerplate is present.
-    -   Run `npm install` to download and install all `devDependencies` specified in the boilerplate's `package.json`.
-    -   Verify that the core boilerplate scripts (`lint`, `format`, `test`, `build`) execute without errors on the initial codebase.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The project directory contains the files and structure from `bmad-boilerplate`.
-    -   AC2: A `node_modules` directory exists and contains packages corresponding to `devDependencies`.
-    -   AC3: `npm run lint` command completes successfully without reporting any linting errors.
-    -   AC4: `npm run format` command completes successfully, potentially making formatting changes according to Prettier rules. Running it a second time should result in no changes.
-    -   AC5: `npm run test` command executes Jest successfully (it may report "no tests found" which is acceptable at this stage).
-    -   AC6: `npm run build` command executes successfully, creating a `dist` directory containing compiled JavaScript output.
-    -   AC7: The `.gitignore` file exists and includes entries for `node_modules/`, `.env`, `dist/`, etc. as specified in the boilerplate.
-
----
-
-### Story 1.2: Setup Environment Configuration
-
--   **User Story / Goal:** As a developer, I want to establish the environment configuration mechanism using `.env` files, so that secrets and settings (like output paths) can be managed outside of version control, following boilerplate conventions.
--   **Detailed Requirements:**
-    -   Verify the `.env.example` file exists (from boilerplate).
-    -   Add an initial configuration variable `OUTPUT_DIR_PATH=./output` to `.env.example`.
-    -   Create the `.env` file locally by copying `.env.example`. Populate `OUTPUT_DIR_PATH` if needed (can keep default).
-    -   Implement a utility module (e.g., `src/config.ts`) that loads environment variables from the `.env` file at application startup.
-    -   The utility should export the loaded configuration values (initially just `OUTPUT_DIR_PATH`).
-    -   Ensure the `.env` file is listed in `.gitignore` and is not committed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: Handle `.env` files with native node 22 support, no need for `dotenv`
-    -   AC2: The `.env.example` file exists, is tracked by git, and contains the line `OUTPUT_DIR_PATH=./output`.
-    -   AC3: The `.env` file exists locally but is NOT tracked by git.
-    -   AC4: A configuration module (`src/config.ts` or similar) exists and successfully loads the `OUTPUT_DIR_PATH` value from `.env` when the application starts.
-    -   AC5: The loaded `OUTPUT_DIR_PATH` value is accessible within the application code.
-
----
-
-### Story 1.3: Implement Basic CLI Entry Point & Execution
-
--   **User Story / Goal:** As a developer, I want a basic `src/index.ts` entry point that can be executed via the boilerplate's `dev` and `start` scripts, providing a working foundation for the application logic.
--   **Detailed Requirements:**
-    -   Create the main application entry point file at `src/index.ts`.
-    -   Implement minimal code within `src/index.ts` to:
-        -   Import the configuration loading mechanism (from Story 1.2).
-        -   Log a simple startup message to the console (e.g., "BMad Hacker Daily Digest - Starting Up...").
-        -   (Optional) Log the loaded `OUTPUT_DIR_PATH` to verify config loading.
-    -   Confirm execution using boilerplate scripts.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `src/index.ts` file exists.
-    -   AC2: Running `npm run dev` executes `src/index.ts` via `ts-node` and logs the startup message to the console.
-    -   AC3: Running `npm run build` successfully compiles `src/index.ts` (and any imports) into the `dist` directory.
-    -   AC4: Running `npm start` (after a successful build) executes the compiled code from `dist` and logs the startup message to the console.
-
----
-
-### Story 1.4: Setup Basic Logging and Output Directory
-
--   **User Story / Goal:** As a developer, I want a basic console logging mechanism and the dynamic creation of a date-stamped output directory, so that the application can provide execution feedback and prepare for storing data artifacts in subsequent epics.
--   **Detailed Requirements:**
-    -   Implement a simple, reusable logging utility module (e.g., `src/logger.ts`). Initially, it can wrap `console.log`, `console.warn`, `console.error`.
-    -   Refactor `src/index.ts` to use this `logger` for its startup message(s).
-    -   In `src/index.ts` (or a setup function called by it):
-        -   Retrieve the `OUTPUT_DIR_PATH` from the configuration (loaded in Story 1.2).
-        -   Determine the current date in 'YYYY-MM-DD' format.
-        -   Construct the full path for the date-stamped subdirectory (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`).
-        -   Check if the base output directory exists; if not, create it.
-        -   Check if the date-stamped subdirectory exists; if not, create it recursively. Use Node.js `fs` module (e.g., `fs.mkdirSync(path, { recursive: true })`).
-        -   Log (using the logger) the full path of the output directory being used for the current run (e.g., "Output directory for this run: ./output/2025-05-04").
--   **Acceptance Criteria (ACs):**
-    -   AC1: A logger utility module (`src/logger.ts` or similar) exists and is used for console output in `src/index.ts`.
-    -   AC2: Running `npm run dev` or `npm start` logs the startup message via the logger.
-    -   AC3: Running the application creates the base output directory (e.g., `./output` defined in `.env`) if it doesn't already exist.
-    -   AC4: Running the application creates a date-stamped subdirectory (e.g., `./output/2025-05-04`) within the base output directory if it doesn't already exist.
-    -   AC5: The application logs a message indicating the full path to the date-stamped output directory created/used for the current execution.
-    -   AC6: The application exits gracefully after performing these setup steps (for now).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 1     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic2.md

@@ -1,99 +0,0 @@
-# Epic 2: HN Data Acquisition & Persistence
-
-**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
-
-## Story List
-
-### Story 2.1: Implement Algolia HN API Client
-
--   **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
--   **Detailed Requirements:**
-    -   Create a new module: `src/clients/algoliaHNClient.ts`.
-    -   Implement an async function `WorkspaceTopStories` within the client:
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
-        -   Parse the JSON response.
-        -   Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
-        -   Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
-        -   Return an array of structured story objects.
-    -   Implement a separate async function `WorkspaceCommentsForStory` within the client:
-        -   Accept `storyId` and `maxComments` limit as arguments.
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
-        -   Parse the JSON response.
-        -   Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
-        -   Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
-        -   Return an array of structured comment objects.
-    -   Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
-    -   Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
-    -   AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
-    -   AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
-    -   AC4: Both functions use the native `Workspace` API internally.
-    -   AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
-    -   AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
-
----
-
-### Story 2.2: Integrate HN Data Fetching into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts` (or a main async function called by it).
-    -   Import the `algoliaHNClient` functions.
-    -   Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
-    -   After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
-    -   Log the number of stories fetched.
-    -   Iterate through the array of fetched `Story` objects.
-    -   For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
-    -   Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
-    -   Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
-    -   AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
-    -   AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
-    -   AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
-
----
-
-### Story 2.3: Persist Fetched HN Data Locally
-
--   **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
--   **Detailed Requirements:**
-    -   Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
-    -   Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
-    -   In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
-        -   Get the full path to the date-stamped output directory (determined in Epic 1).
-        -   Construct the filename for the story's data: `{storyId}_data.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
-        -   Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
-    -   Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
-    -   AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
-    -   AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
-    -   AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
-
----
-
-### Story 2.4: Implement Stage Testing Utility for HN Fetching
-
--   **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
-    -   This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
-    -   The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
-    -   The script should log its progress using the logger utility.
-    -   Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/fetch_hn_data.ts` exists.
-    -   AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
-    -   AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
-    -   AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
-    -   AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 2     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic2.txt

@@ -1,99 +0,0 @@
-# Epic 2: HN Data Acquisition & Persistence
-
-**Goal:** Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally into the date-stamped output directory created in Epic 1. Implement a stage testing utility for fetching.
-
-## Story List
-
-### Story 2.1: Implement Algolia HN API Client
-
--   **User Story / Goal:** As a developer, I want a dedicated client module to interact with the Algolia Hacker News Search API, so that fetching stories and comments is encapsulated, reusable, and uses the required native `Workspace` API.
--   **Detailed Requirements:**
-    -   Create a new module: `src/clients/algoliaHNClient.ts`.
-    -   Implement an async function `WorkspaceTopStories` within the client:
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for front-page stories (e.g., `http://hn.algolia.com/api/v1/search?tags=front_page&hitsPerPage=10`). Adjust `hitsPerPage` if needed to ensure 10 stories.
-        -   Parse the JSON response.
-        -   Extract required metadata for each story: `objectID` (use as `storyId`), `title`, `url` (article URL), `points`, `num_comments`. Handle potential missing `url` field gracefully (log warning, maybe skip story later if URL needed).
-        -   Construct the `hnUrl` for each story (e.g., `https://news.ycombinator.com/item?id={storyId}`).
-        -   Return an array of structured story objects.
-    -   Implement a separate async function `WorkspaceCommentsForStory` within the client:
-        -   Accept `storyId` and `maxComments` limit as arguments.
-        -   Use native `Workspace` to call the Algolia HN Search API endpoint for comments of a specific story (e.g., `http://hn.algolia.com/api/v1/search?tags=comment,story_{storyId}&hitsPerPage={maxComments}`).
-        -   Parse the JSON response.
-        -   Extract required comment data: `objectID` (use as `commentId`), `comment_text`, `author`, `created_at`.
-        -   Filter out comments where `comment_text` is null or empty. Ensure only up to `maxComments` are returned.
-        -   Return an array of structured comment objects.
-    -   Implement basic error handling using `try...catch` around `Workspace` calls and check `response.ok` status. Log errors using the logger utility from Epic 1.
-    -   Define TypeScript interfaces/types for the expected structures of API responses (stories, comments) and the data returned by the client functions (e.g., `Story`, `Comment`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The module `src/clients/algoliaHNClient.ts` exists and exports `WorkspaceTopStories` and `WorkspaceCommentsForStory` functions.
-    -   AC2: Calling `WorkspaceTopStories` makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of 10 `Story` objects containing the specified metadata.
-    -   AC3: Calling `WorkspaceCommentsForStory` with a valid `storyId` and `maxComments` limit makes a network request to the correct Algolia endpoint and returns a promise resolving to an array of `Comment` objects (up to `maxComments`), filtering out empty ones.
-    -   AC4: Both functions use the native `Workspace` API internally.
-    -   AC5: Network errors or non-successful API responses (e.g., status 4xx, 5xx) are caught and logged using the logger.
-    -   AC6: Relevant TypeScript types (`Story`, `Comment`, etc.) are defined and used within the client module.
-
----
-
-### Story 2.2: Integrate HN Data Fetching into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the HN data fetching logic into the main application workflow (`src/index.ts`), so that running the app retrieves the top 10 stories and their comments after completing the setup from Epic 1.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts` (or a main async function called by it).
-    -   Import the `algoliaHNClient` functions.
-    -   Import the configuration module to access `MAX_COMMENTS_PER_STORY`.
-    -   After the Epic 1 setup (config load, logger init, output dir creation), call `WorkspaceTopStories()`.
-    -   Log the number of stories fetched.
-    -   Iterate through the array of fetched `Story` objects.
-    -   For each `Story`, call `WorkspaceCommentsForStory()`, passing the `story.storyId` and the configured `MAX_COMMENTS_PER_STORY`.
-    -   Store the fetched comments within the corresponding `Story` object in memory (e.g., add a `comments: Comment[]` property to the `Story` object).
-    -   Log progress using the logger utility (e.g., "Fetched 10 stories.", "Fetching up to X comments for story {storyId}...").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 setup steps followed by fetching stories and then comments for each story.
-    -   AC2: Logs clearly show the start and successful completion of fetching stories, and the start of fetching comments for each of the 10 stories.
-    -   AC3: The configured `MAX_COMMENTS_PER_STORY` value is read from config and used in the calls to `WorkspaceCommentsForStory`.
-    -   AC4: After successful execution, story objects held in memory contain a nested array of fetched comment objects. (Can be verified via debugger or temporary logging).
-
----
-
-### Story 2.3: Persist Fetched HN Data Locally
-
--   **User Story / Goal:** As a developer, I want to save the fetched HN stories (including their comments) to JSON files in the date-stamped output directory, so that the raw data is persisted locally for subsequent pipeline stages and debugging.
--   **Detailed Requirements:**
-    -   Define a consistent JSON structure for the output file content. Example: `{ storyId: "...", title: "...", url: "...", hnUrl: "...", points: ..., fetchedAt: "ISO_TIMESTAMP", comments: [{ commentId: "...", text: "...", author: "...", createdAt: "ISO_TIMESTAMP", ... }, ...] }`. Include a timestamp for when the data was fetched.
-    -   Import Node.js `fs` (specifically `fs.writeFileSync`) and `path` modules.
-    -   In the main workflow (`src/index.ts`), within the loop iterating through stories (after comments have been fetched and added to the story object in Story 2.2):
-        -   Get the full path to the date-stamped output directory (determined in Epic 1).
-        -   Construct the filename for the story's data: `{storyId}_data.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the complete story object (including comments and fetch timestamp) to a JSON string using `JSON.stringify(storyObject, null, 2)` for readability.
-        -   Write the JSON string to the file using `fs.writeFileSync()`. Use a `try...catch` block for error handling.
-    -   Log (using the logger) the successful persistence of each story's data file or any errors encountered during file writing.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory (e.g., `./output/YYYY-MM-DD/`) contains exactly 10 files named `{storyId}_data.json`.
-    -   AC2: Each JSON file contains valid JSON representing a single story object, including its metadata, fetch timestamp, and an array of its fetched comments, matching the defined structure.
-    -   AC3: The number of comments in each file's `comments` array does not exceed `MAX_COMMENTS_PER_STORY`.
-    -   AC4: Logs indicate that saving data to a file was attempted for each story, reporting success or specific file writing errors.
-
----
-
-### Story 2.4: Implement Stage Testing Utility for HN Fetching
-
--   **User Story / Goal:** As a developer, I want a separate, executable script that *only* performs the HN data fetching and persistence, so I can test and trigger this stage independently of the full pipeline.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/fetch_hn_data.ts`.
-    -   This script should perform the essential setup required for this stage: initialize logger, load configuration (`.env`), determine and create output directory (reuse or replicate logic from Epic 1 / `src/index.ts`).
-    -   The script should then execute the core logic of fetching stories via `algoliaHNClient.fetchTopStories`, fetching comments via `algoliaHNClient.fetchCommentsForStory` (using loaded config for limit), and persisting the results to JSON files using `fs.writeFileSync` (replicating logic from Story 2.3).
-    -   The script should log its progress using the logger utility.
-    -   Add a new script command to `package.json` under `"scripts"`: `"stage:fetch": "ts-node src/stages/fetch_hn_data.ts"`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/fetch_hn_data.ts` exists.
-    -   AC2: The script `stage:fetch` is defined in `package.json`'s `scripts` section.
-    -   AC3: Running `npm run stage:fetch` executes successfully, performing only the setup, fetch, and persist steps.
-    -   AC4: Running `npm run stage:fetch` creates the same 10 `{storyId}_data.json` files in the correct date-stamped output directory as running the main `npm run dev` command (at the current state of development).
-    -   AC5: Logs generated by `npm run stage:fetch` reflect only the fetching and persisting steps, not subsequent pipeline stages.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 2     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic3.md

@@ -1,111 +0,0 @@
-# Epic 3: Article Scraping & Persistence
-
-**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
-
-## Story List
-
-### Story 3.1: Implement Basic Article Scraper Module
-
--   **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
--   **Detailed Requirements:**
-    -   Create a new module: `src/scraper/articleScraper.ts`.
-    -   Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
-    -   Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
-    -   Inside the function:
-        -   Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
-        -   Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
-        -   Check the `response.ok` status. If not okay, log error and return `null`.
-        -   Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
-        -   If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
-        -   Wrap the extraction logic in a `try...catch` to handle library-specific errors.
-        -   Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
-        -   Return `null` if extraction fails or results in empty content.
-    -   Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
-    -   Define TypeScript types/interfaces as needed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
-    -   AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
-    -   AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
-    -   AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
-    -   AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
-    -   AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
-    -   AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
-
----
-
-### Story 3.2: Integrate Article Scraping into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
-    -   Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
-        -   Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
-        -   If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
-        -   If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
-        -   Call `await scrapeArticle(story.url)`.
-        -   Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
-        -   Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
-    -   AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
-    -   AC3: For stories with valid URLs, the `scrapeArticle` function is called.
-    -   AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
-    -   AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
-
----
-
-### Story 3.3: Persist Scraped Article Text Locally
-
--   **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
--   **Detailed Requirements:**
-    -   Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
-    -   In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
-        -   Retrieve the full path to the current date-stamped output directory.
-        -   Construct the filename: `{storyId}_article.txt`.
-        -   Construct the full file path using `path.join()`.
-        -   Get the successfully scraped article text string (`articleContent`).
-        -   Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
-        -   Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
-    -   Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
-    -   AC2: The name of each article text file is `{storyId}_article.txt`.
-    -   AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
-    -   AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
-    -   AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
-
----
-
-### Story 3.4: Implement Stage Testing Utility for Scraping
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/scrape_articles.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
-    -   The script should:
-        -   Initialize the logger.
-        -   Load configuration (to get `OUTPUT_DIR_PATH`).
-        -   Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
-        -   Read the directory contents and identify all `{storyId}_data.json` files.
-        -   For each `_data.json` file found:
-            -   Read and parse the JSON content.
-            -   Extract the `storyId` and `url`.
-            -   If a valid `url` exists, call `await scrapeArticle(url)`.
-            -   If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
-            -   Log the progress and outcome (skip/success/fail) for each story processed.
-    -   Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/scrape_articles.ts` exists.
-    -   AC2: The script `stage:scrape` is defined in `package.json`.
-    -   AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
-    -   AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
-    -   AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
-    -   AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
-    -   AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 3     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic3.txt

@@ -1,111 +0,0 @@
-# Epic 3: Article Scraping & Persistence
-
-**Goal:** Implement a best-effort article scraping mechanism to fetch and extract plain text content from the external URLs associated with fetched HN stories. Handle failures gracefully and persist successfully scraped text locally. Implement a stage testing utility for scraping.
-
-## Story List
-
-### Story 3.1: Implement Basic Article Scraper Module
-
--   **User Story / Goal:** As a developer, I want a module that attempts to fetch HTML from a URL and extract the main article text using basic methods, handling common failures gracefully, so article content can be prepared for summarization.
--   **Detailed Requirements:**
-    -   Create a new module: `src/scraper/articleScraper.ts`.
-    -   Add a suitable HTML parsing/extraction library dependency (e.g., `@extractus/article-extractor` recommended for simplicity, or `cheerio` for more control). Run `npm install @extractus/article-extractor --save-prod` (or chosen alternative).
-    -   Implement an async function `scrapeArticle(url: string): Promise<string | null>` within the module.
-    -   Inside the function:
-        -   Use native `Workspace` to retrieve content from the `url`. Set a reasonable timeout (e.g., 10-15 seconds). Include a `User-Agent` header to mimic a browser.
-        -   Handle potential `Workspace` errors (network errors, timeouts) using `try...catch`.
-        -   Check the `response.ok` status. If not okay, log error and return `null`.
-        -   Check the `Content-Type` header of the response. If it doesn't indicate HTML (e.g., does not include `text/html`), log warning and return `null`.
-        -   If HTML is received, attempt to extract the main article text using the chosen library (`article-extractor` preferred).
-        -   Wrap the extraction logic in a `try...catch` to handle library-specific errors.
-        -   Return the extracted plain text string if successful. Ensure it's just text, not HTML markup.
-        -   Return `null` if extraction fails or results in empty content.
-    -   Log all significant events, errors, or reasons for returning null (e.g., "Scraping URL...", "Fetch failed:", "Non-HTML content type:", "Extraction failed:", "Successfully extracted text") using the logger utility.
-    -   Define TypeScript types/interfaces as needed.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `articleScraper.ts` module exists and exports the `scrapeArticle` function.
-    -   AC2: The chosen scraping library (e.g., `@extractus/article-extractor`) is added to `dependencies` in `package.json`.
-    -   AC3: `scrapeArticle` uses native `Workspace` with a timeout and User-Agent header.
-    -   AC4: `scrapeArticle` correctly handles fetch errors, non-OK responses, and non-HTML content types by logging and returning `null`.
-    -   AC5: `scrapeArticle` uses the chosen library to attempt text extraction from valid HTML content.
-    -   AC6: `scrapeArticle` returns the extracted plain text on success, and `null` on any failure (fetch, non-HTML, extraction error, empty result).
-    -   AC7: Relevant logs are produced for success, failure modes, and errors encountered during the process.
-
----
-
-### Story 3.2: Integrate Article Scraping into Main Workflow
-
--   **User Story / Goal:** As a developer, I want to integrate the article scraper into the main workflow (`src/index.ts`), attempting to scrape the article for each HN story that has a valid URL, after fetching its data.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import the `scrapeArticle` function from `src/scraper/articleScraper.ts`.
-    -   Within the main loop iterating through the fetched stories (after comments are fetched in Epic 2):
-        -   Check if `story.url` exists and appears to be a valid HTTP/HTTPS URL. A simple check for starting with `http://` or `https://` is sufficient.
-        -   If the URL is missing or invalid, log a warning ("Skipping scraping for story {storyId}: Missing or invalid URL") and proceed to the next story's processing step.
-        -   If a valid URL exists, log ("Attempting to scrape article for story {storyId} from {story.url}").
-        -   Call `await scrapeArticle(story.url)`.
-        -   Store the result (the extracted text string or `null`) in memory, associated with the story object (e.g., add property `articleContent: string | null`).
-        -   Log the outcome clearly (e.g., "Successfully scraped article for story {storyId}", "Failed to scrape article for story {storyId}").
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes Epic 1 & 2 steps, and then attempts article scraping for stories with valid URLs.
-    -   AC2: Stories with missing or invalid URLs are skipped, and a corresponding log message is generated.
-    -   AC3: For stories with valid URLs, the `scrapeArticle` function is called.
-    -   AC4: Logs clearly indicate the start and success/failure outcome of the scraping attempt for each relevant story.
-    -   AC5: Story objects held in memory after this stage contain an `articleContent` property holding the scraped text (string) or `null` if scraping was skipped or failed.
-
----
-
-### Story 3.3: Persist Scraped Article Text Locally
-
--   **User Story / Goal:** As a developer, I want to save successfully scraped article text to a separate local file for each story, so that the text content is available as input for the summarization stage.
--   **Detailed Requirements:**
-    -   Import Node.js `fs` and `path` modules if not already present in `src/index.ts`.
-    -   In the main workflow (`src/index.ts`), immediately after a successful call to `scrapeArticle` for a story (where the result is a non-null string):
-        -   Retrieve the full path to the current date-stamped output directory.
-        -   Construct the filename: `{storyId}_article.txt`.
-        -   Construct the full file path using `path.join()`.
-        -   Get the successfully scraped article text string (`articleContent`).
-        -   Use `fs.writeFileSync(fullPath, articleContent, 'utf-8')` to save the text to the file. Wrap in `try...catch` for file system errors.
-        -   Log the successful saving of the file (e.g., "Saved scraped article text to {filename}") or any file writing errors encountered.
-    -   Ensure *no* `_article.txt` file is created if `scrapeArticle` returned `null` (due to skipping or failure).
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains `_article.txt` files *only* for those stories where `scrapeArticle` succeeded and returned text content.
-    -   AC2: The name of each article text file is `{storyId}_article.txt`.
-    -   AC3: The content of each `_article.txt` file is the plain text string returned by `scrapeArticle`.
-    -   AC4: Logs confirm the successful writing of each `_article.txt` file or report specific file writing errors.
-    -   AC5: No empty `_article.txt` files are created. Files only exist if scraping was successful.
-
----
-
-### Story 3.4: Implement Stage Testing Utility for Scraping
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the article scraping logic using HN story data from local files, allowing independent testing and debugging of the scraper.
--   **Detailed Requirements:**
-    -   Create a new standalone script file: `src/stages/scrape_articles.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `scrapeArticle`.
-    -   The script should:
-        -   Initialize the logger.
-        -   Load configuration (to get `OUTPUT_DIR_PATH`).
-        -   Determine the target date-stamped directory path (e.g., `${OUTPUT_DIR_PATH}/YYYY-MM-DD`, using the current date or potentially an optional CLI argument). Ensure this directory exists.
-        -   Read the directory contents and identify all `{storyId}_data.json` files.
-        -   For each `_data.json` file found:
-            -   Read and parse the JSON content.
-            -   Extract the `storyId` and `url`.
-            -   If a valid `url` exists, call `await scrapeArticle(url)`.
-            -   If scraping succeeds (returns text), save the text to `{storyId}_article.txt` in the same directory (using logic from Story 3.3). Overwrite if the file exists.
-            -   Log the progress and outcome (skip/success/fail) for each story processed.
-    -   Add a new script command to `package.json`: `"stage:scrape": "ts-node src/stages/scrape_articles.ts"`. Consider adding argument parsing later if needed to specify a date/directory.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/scrape_articles.ts` exists.
-    -   AC2: The script `stage:scrape` is defined in `package.json`.
-    -   AC3: Running `npm run stage:scrape` (assuming a directory with `_data.json` files exists from a previous `stage:fetch` run) reads these files.
-    -   AC4: The script calls `scrapeArticle` for stories with valid URLs found in the JSON files.
-    -   AC5: The script creates/updates `{storyId}_article.txt` files in the target directory corresponding to successfully scraped articles.
-    -   AC6: The script logs its actions (reading files, attempting scraping, saving results) for each story ID processed.
-    -   AC7: The script operates solely based on local `_data.json` files and fetching from external article URLs; it does not call the Algolia HN API.
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 3     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic4.md

@@ -1,146 +0,0 @@
-# Epic 4: LLM Summarization & Persistence
-
-**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
-
-## Story List
-
-### Story 4.1: Implement Ollama Client Module
-
--   **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
--   **Detailed Requirements:**
-    -   **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
-    -   Create a new module: `src/clients/ollamaClient.ts`.
-    -   Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
-    -   Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
-    -   Inside `generateSummary`:
-        -   Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
-        -   Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
-        -   Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
-        -   Handle `Workspace` errors (network, timeout) using `try...catch`.
-        -   Check `response.ok`. If not OK, log the status/error and return `null`.
-        -   Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
-        -   Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
-        -   Return the extracted summary string on success. Return `null` on any failure.
-        -   Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
-    -   Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
-    -   AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
-    -   AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
-    -   AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
-    -   AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
-    * AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
-    * AC7: Logs provide visibility into the client's interaction with the Ollama API.
-
----
-
-### Story 4.2: Define Summarization Prompts
-
-* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
-* **Detailed Requirements:**
-    * Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
-    * Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
-
----
-
-### Story 4.3: Integrate Summarization into Main Workflow
-
-* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
-* **Detailed Requirements:**
-    * Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
-    * Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
-    * Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
-    * Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
-    * **Article Summary Generation:**
-        * Check if the `story` object has non-null `articleContent`.
-        * If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
-        * If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
-    * **Discussion Summary Generation:**
-        * Check if the `story` object has a non-empty `comments` array.
-        * If yes:
-            * Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
-            * **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
-            * Log "Attempting discussion summarization for story {storyId}".
-            * Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
-            * Store the result (string or null) as `story.discussionSummary`. Log success/failure.
-        * If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
-* **Acceptance Criteria (ACs):**
-    * AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
-    * AC2: Article summary is attempted only if `articleContent` exists for a story.
-    * AC3: Discussion summary is attempted only if `comments` exist for a story.
-    * AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
-    * AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
-    * AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
-
----
-
-### Story 4.4: Persist Generated Summaries Locally
-
-*(No changes needed for this story based on recent decisions)*
-
--   **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
--   **Detailed Requirements:**
-    -   Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
-    -   Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
-    -   In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
-        -   Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
-        -   Get the full path to the date-stamped output directory.
-        -   Construct the filename: `{storyId}_summary.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
-        -   Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
-        -   Log the successful saving of the summary file or any file writing errors.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
-    -   AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
-    -   AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC5: A valid ISO timestamp is present in the `summarizedAt` field.
-    -   AC6: Logs confirm successful writing of each summary file or report file system errors.
-
----
-
-### Story 4.5: Implement Stage Testing Utility for Summarization
-
-*(Changes needed to reflect prompt sourcing and optional truncation)*
-
-* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
-* **Detailed Requirements:**
-    * Create a new standalone script file: `src/stages/summarize_content.ts`.
-    * Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
-    * The script should:
-        * Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
-        * Determine target date-stamped directory path.
-        * Find all `{storyId}_data.json` files in the directory.
-        * For each `storyId` found:
-            * Read `{storyId}_data.json` to get comments. Format them into a single text block.
-            * *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
-            * Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
-            * **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
-            * Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
-            * Construct the summary result object (with summaries or nulls, and timestamp).
-            * Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
-            * Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
-    * Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The file `src/stages/summarize_content.ts` exists.
-    * AC2: The script `stage:summarize` is defined in `package.json`.
-    * AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
-    * AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
-    * AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
-    * AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
-    * AC8: The script does not call Algolia API or the article scraper module.
-
-## Change Log
-
-| Change                      | Date         | Version | Description                          | Author         |
-| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
-| Integrate prompts.md refs   | 2025-05-04   | 0.3     | Updated stories 4.2, 4.3, 4.5        | 3-Architect    |
-| Added Ollama Prereq Note    | 2025-05-04   | 0.2     | Added note about local Ollama setup  | 2-pm           |
-| Initial Draft               | 2025-05-04   | 0.1     | First draft of Epic 4                | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic4.txt

@@ -1,146 +0,0 @@
-# Epic 4: LLM Summarization & Persistence
-
-**Goal:** Integrate with the configured local Ollama instance to generate summaries for successfully scraped article text and fetched comments. Persist these summaries locally. Implement a stage testing utility for summarization.
-
-## Story List
-
-### Story 4.1: Implement Ollama Client Module
-
--   **User Story / Goal:** As a developer, I want a client module to interact with the configured Ollama API endpoint via HTTP, handling requests and responses for text generation, so that summaries can be generated programmatically.
--   **Detailed Requirements:**
-    -   **Prerequisite:** Ensure a local Ollama instance is installed and running, accessible via the URL defined in `.env` (`OLLAMA_ENDPOINT_URL`), and that the model specified in `.env` (`OLLAMA_MODEL`) has been downloaded (e.g., via `ollama pull model_name`). Instructions for this setup should be in the project README.
-    -   Create a new module: `src/clients/ollamaClient.ts`.
-    -   Implement an async function `generateSummary(promptTemplate: string, content: string): Promise<string | null>`. *(Note: Parameter name changed for clarity)*
-    -   Add configuration variables `OLLAMA_ENDPOINT_URL` (e.g., `http://localhost:11434`) and `OLLAMA_MODEL` (e.g., `llama3`) to `.env.example`. Ensure they are loaded via the config module (`src/utils/config.ts`). Update local `.env` with actual values. Add optional `OLLAMA_TIMEOUT_MS` to `.env.example` with a default like `120000`.
-    -   Inside `generateSummary`:
-        -   Construct the full prompt string using the `promptTemplate` and the provided `content` (e.g., replacing a placeholder like `{Content Placeholder}` in the template, or simple concatenation if templates are basic).
-        -   Construct the Ollama API request payload (JSON): `{ model: configured_model, prompt: full_prompt, stream: false }`. Refer to Ollama `/api/generate` documentation and `docs/data-models.md`.
-        -   Use native `Workspace` to send a POST request to the configured Ollama endpoint + `/api/generate`. Set appropriate headers (`Content-Type: application/json`). Use the configured `OLLAMA_TIMEOUT_MS` or a reasonable default (e.g., 2 minutes).
-        -   Handle `Workspace` errors (network, timeout) using `try...catch`.
-        -   Check `response.ok`. If not OK, log the status/error and return `null`.
-        -   Parse the JSON response from Ollama. Extract the generated text (typically in the `response` field). Refer to `docs/data-models.md`.
-        -   Check for potential errors within the Ollama response structure itself (e.g., an `error` field).
-        -   Return the extracted summary string on success. Return `null` on any failure.
-        -   Log key events: initiating request (mention model), receiving response, success, failure reasons, potentially request/response time using the logger.
-    -   Define necessary TypeScript types for the Ollama request payload and expected response structure in `src/types/ollama.ts` (referenced in `docs/data-models.md`).
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `ollamaClient.ts` module exists and exports `generateSummary`.
-    -   AC2: `OLLAMA_ENDPOINT_URL` and `OLLAMA_MODEL` are defined in `.env.example`, loaded via config, and used by the client. Optional `OLLAMA_TIMEOUT_MS` is handled.
-    -   AC3: `generateSummary` sends a correctly formatted POST request (model, full prompt based on template and content, stream:false) to the configured Ollama endpoint/path using native `Workspace`.
-    -   AC4: Network errors, timeouts, and non-OK API responses are handled gracefully, logged, and result in a `null` return (given the Prerequisite Ollama service is running).
-    -   AC5: A successful Ollama response is parsed correctly, the generated text is extracted, and returned as a string.
-    * AC6: Unexpected Ollama response formats or internal errors (e.g., `{"error": "..."}`) are handled, logged, and result in a `null` return.
-    * AC7: Logs provide visibility into the client's interaction with the Ollama API.
-
----
-
-### Story 4.2: Define Summarization Prompts
-
-* **User Story / Goal:** As a developer, I want standardized base prompts for generating article summaries and HN discussion summaries documented centrally, ensuring consistent instructions are sent to the LLM.
-* **Detailed Requirements:**
-    * Define two standardized base prompts (`ARTICLE_SUMMARY_PROMPT`, `DISCUSSION_SUMMARY_PROMPT`) **and document them in `docs/prompts.md`**.
-    * Ensure these prompts are accessible within the application code, for example, by defining them as exported constants in a dedicated module like `src/utils/prompts.ts`, which reads from or mirrors the content in `docs/prompts.md`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The `ARTICLE_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC2: The `DISCUSSION_SUMMARY_PROMPT` text is defined in `docs/prompts.md` with appropriate instructional content.
-    * AC3: The prompt texts documented in `docs/prompts.md` are available as constants or variables within the application code (e.g., via `src/utils/prompts.ts`) for use by the Ollama client integration.
-
----
-
-### Story 4.3: Integrate Summarization into Main Workflow
-
-* **User Story / Goal:** As a developer, I want to integrate the Ollama client into the main workflow to generate summaries for each story's scraped article text (if available) and fetched comments, using centrally defined prompts and handling potential comment length limits.
-* **Detailed Requirements:**
-    * Modify the main execution flow in `src/index.ts` or `src/core/pipeline.ts`.
-    * Import `ollamaClient.generateSummary` and the prompt constants/variables (e.g., from `src/utils/prompts.ts`, which reflect `docs/prompts.md`).
-    * Load the optional `MAX_COMMENT_CHARS_FOR_SUMMARY` configuration value from `.env` via the config utility.
-    * Within the main loop iterating through stories (after article scraping/persistence in Epic 3):
-    * **Article Summary Generation:**
-        * Check if the `story` object has non-null `articleContent`.
-        * If yes: log "Attempting article summarization for story {storyId}", call `await generateSummary(ARTICLE_SUMMARY_PROMPT, story.articleContent)`, store the result (string or null) as `story.articleSummary`, log success/failure.
-        * If no: set `story.articleSummary = null`, log "Skipping article summarization: No content".
-    * **Discussion Summary Generation:**
-        * Check if the `story` object has a non-empty `comments` array.
-        * If yes:
-            * Format the `story.comments` array into a single text block suitable for the LLM prompt (e.g., concatenating `comment.text` with separators like `---`).
-            * **Check truncation limit:** If `MAX_COMMENT_CHARS_FOR_SUMMARY` is configured to a positive number and the `formattedCommentsText` length exceeds it, truncate `formattedCommentsText` to the limit and log a warning: "Comment text truncated to {limit} characters for summarization for story {storyId}".
-            * Log "Attempting discussion summarization for story {storyId}".
-            * Call `await generateSummary(DISCUSSION_SUMMARY_PROMPT, formattedCommentsText)`. *(Pass the potentially truncated text)*
-            * Store the result (string or null) as `story.discussionSummary`. Log success/failure.
-        * If no: set `story.discussionSummary = null`, log "Skipping discussion summarization: No comments".
-* **Acceptance Criteria (ACs):**
-    * AC1: Running `npm run dev` executes steps from Epics 1-3, then attempts summarization using the Ollama client.
-    * AC2: Article summary is attempted only if `articleContent` exists for a story.
-    * AC3: Discussion summary is attempted only if `comments` exist for a story.
-    * AC4: `generateSummary` is called with the correct prompts (sourced consistently with `docs/prompts.md`) and corresponding content (article text or formatted/potentially truncated comments).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and comment text exceeds it, the text passed to `generateSummary` is truncated, and a warning is logged.
-    * AC6: Logs clearly indicate the start, success, or failure (including null returns from the client) for both article and discussion summarization attempts per story.
-    * AC7: Story objects in memory now contain `articleSummary` (string/null) and `discussionSummary` (string/null) properties.
-
----
-
-### Story 4.4: Persist Generated Summaries Locally
-
-*(No changes needed for this story based on recent decisions)*
-
--   **User Story / Goal:** As a developer, I want to save the generated article and discussion summaries (or null placeholders) to a local JSON file for each story, making them available for the email assembly stage.
--   **Detailed Requirements:**
-    -   Define the structure for the summary output file: `{storyId}_summary.json`. Content example: `{ "storyId": "...", "articleSummary": "...", "discussionSummary": "...", "summarizedAt": "ISO_TIMESTAMP" }`. Note that `articleSummary` and `discussionSummary` can be `null`.
-    -   Import `fs` and `path` in `src/index.ts` or `src/core/pipeline.ts` if needed.
-    -   In the main workflow loop, after *both* summarization attempts (article and discussion) for a story are complete:
-        -   Create a summary result object containing `storyId`, `articleSummary` (string or null), `discussionSummary` (string or null), and the current ISO timestamp (`new Date().toISOString()`). Add this timestamp to the in-memory `story` object as well (`story.summarizedAt`).
-        -   Get the full path to the date-stamped output directory.
-        -   Construct the filename: `{storyId}_summary.json`.
-        -   Construct the full file path using `path.join()`.
-        -   Serialize the summary result object to JSON (`JSON.stringify(..., null, 2)`).
-        -   Use `fs.writeFileSync` to save the JSON to the file, wrapping in `try...catch`.
-        -   Log the successful saving of the summary file or any file writing errors.
--   **Acceptance Criteria (ACs):**
-    -   AC1: After running `npm run dev`, the date-stamped output directory contains 10 files named `{storyId}_summary.json`.
-    -   AC2: Each `_summary.json` file contains valid JSON adhering to the defined structure.
-    -   AC3: The `articleSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC4: The `discussionSummary` field contains the generated summary string if successful, otherwise `null`.
-    -   AC5: A valid ISO timestamp is present in the `summarizedAt` field.
-    -   AC6: Logs confirm successful writing of each summary file or report file system errors.
-
----
-
-### Story 4.5: Implement Stage Testing Utility for Summarization
-
-*(Changes needed to reflect prompt sourcing and optional truncation)*
-
-* **User Story / Goal:** As a developer, I want a separate script/command to test the LLM summarization logic using locally persisted data (HN comments, scraped article text), allowing independent testing of prompts and Ollama interaction.
-* **Detailed Requirements:**
-    * Create a new standalone script file: `src/stages/summarize_content.ts`.
-    * Import necessary modules: `fs`, `path`, `logger`, `config`, `ollamaClient`, prompt constants (e.g., from `src/utils/prompts.ts`).
-    * The script should:
-        * Initialize logger, load configuration (Ollama endpoint/model, output dir, **optional `MAX_COMMENT_CHARS_FOR_SUMMARY`**).
-        * Determine target date-stamped directory path.
-        * Find all `{storyId}_data.json` files in the directory.
-        * For each `storyId` found:
-            * Read `{storyId}_data.json` to get comments. Format them into a single text block.
-            * *Attempt* to read `{storyId}_article.txt`. Handle file-not-found gracefully. Store content or null.
-            * Call `ollamaClient.generateSummary` for article text (if not null) using `ARTICLE_SUMMARY_PROMPT`.
-            * **Apply truncation logic:** If comments exist, check `MAX_COMMENT_CHARS_FOR_SUMMARY` and truncate the formatted comment text block if needed, logging a warning.
-            * Call `ollamaClient.generateSummary` for formatted comments (if comments exist) using `DISCUSSION_SUMMARY_PROMPT` *(passing potentially truncated text)*.
-            * Construct the summary result object (with summaries or nulls, and timestamp).
-            * Save the result object to `{storyId}_summary.json` in the same directory (using logic from Story 4.4), overwriting if exists.
-            * Log progress (reading files, calling Ollama, truncation warnings, saving results) for each story ID.
-    * Add script to `package.json`: `"stage:summarize": "ts-node src/stages/summarize_content.ts"`.
-* **Acceptance Criteria (ACs):**
-    * AC1: The file `src/stages/summarize_content.ts` exists.
-    * AC2: The script `stage:summarize` is defined in `package.json`.
-    * AC3: Running `npm run stage:summarize` (after `stage:fetch` and `stage:scrape` runs) reads `_data.json` and attempts to read `_article.txt` files from the target directory.
-    * AC4: The script calls the `ollamaClient` with correct prompts (sourced consistently with `docs/prompts.md`) and content derived *only* from the local files (requires Ollama service running per Story 4.1 prerequisite).
-    * AC5: If `MAX_COMMENT_CHARS_FOR_SUMMARY` is set and applicable, comment text is truncated before calling the client, and a warning is logged.
-    * AC6: The script creates/updates `{storyId}_summary.json` files in the target directory reflecting the results of the Ollama calls (summaries or nulls).
-    * AC7: Logs show the script processing each story ID found locally, interacting with Ollama, and saving results.
-    * AC8: The script does not call Algolia API or the article scraper module.
-
-## Change Log
-
-| Change                      | Date         | Version | Description                          | Author         |
-| --------------------------- | ------------ | ------- | ------------------------------------ | -------------- |
-| Integrate prompts.md refs   | 2025-05-04   | 0.3     | Updated stories 4.2, 4.3, 4.5        | 3-Architect    |
-| Added Ollama Prereq Note    | 2025-05-04   | 0.2     | Added note about local Ollama setup  | 2-pm           |
-| Initial Draft               | 2025-05-04   | 0.1     | First draft of Epic 4                | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic5.md

@@ -1,152 +0,0 @@
-# Epic 5: Digest Assembly & Email Dispatch
-
-**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
-
-## Story List
-
-### Story 5.1: Implement Email Content Assembler
-
--   **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
--   **Detailed Requirements:**
-    -   Create a new module: `src/email/contentAssembler.ts`.
-    -   Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
-    -   Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
-    -   The function should:
-        -   Use Node.js `fs` to read the contents of the `dateDirPath`.
-        -   Identify all files matching the pattern `{storyId}_data.json`.
-        -   For each `storyId` found:
-            -   Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
-            -   Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
-            -   Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
-        -   Collect all successfully constructed `DigestData` objects into an array.
-        -   Return the array. It should ideally contain 10 items if all previous stages succeeded.
-    -   Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
-    -   AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
-    -   AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
-    -   AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
-    -   AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
-
----
-
-### Story 5.2: Create HTML Email Template & Renderer
-
--   **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
--   **Detailed Requirements:**
-    -   Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
-    -   Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
-    -   The function should generate an HTML string with:
-        -   A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
-        -   A loop through the `data` array.
-        -   For each `story` in `data`:
-            -   Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
-            -   Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
-            -   Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
-            -   Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
-            -   Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
-    -   Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
-    -   Return the complete HTML document as a string.
--   **Acceptance Criteria (ACs):**
-    -   AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
-    -   AC2: The function returns a single, complete HTML string.
-    -   AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
-    -   AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
-    -   AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
-
----
-
-### Story 5.3: Implement Nodemailer Email Sender
-
--   **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
--   **Detailed Requirements:**
-    -   Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
-    -   Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
-    -   Create a new module: `src/email/emailSender.ts`.
-    -   Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
-    -   Inside the function:
-        -   Load the `EMAIL_*` variables from the config module.
-        -   Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
-        -   Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
-        -   Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
-        -   Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
-        -   Call `await transporter.sendMail(mailOptions)`.
-        -   If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
-        -   If `sendMail` fails (throws error), log the error using the logger. Return `false`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
-    -   AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
-    -   AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
-    -   AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
-    -   AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
-    -   AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
-    -   AC7: Email sending success (including message ID) or failure is logged clearly.
-    -   AC8: The function returns `true` on successful sending, `false` otherwise.
-
----
-
-### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
-
--   **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
-    -   Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
-        -   Log "Starting final digest assembly and email dispatch...".
-        -   Determine the path to the current date-stamped output directory.
-        -   Call `const digestData = await assembleDigestData(dateDirPath)`.
-        -   Check if `digestData` array is not empty.
-            -   If yes:
-                -   Get the current date string (e.g., 'YYYY-MM-DD').
-                -   `const htmlContent = renderDigestHtml(digestData, currentDate)`.
-                -   `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
-                -   `const emailSent = await sendDigestEmail(subject, htmlContent)`.
-                -   Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
-            -   If no (`digestData` is empty or assembly failed):
-                -   Log an error: "Failed to assemble digest data or no data found. Skipping email."
-        -   Log "BMad Hacker Daily Digest process finished."
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
-    -   AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
-    -   AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
-    -   AC4: The final success or failure of the email sending step is logged.
-    -   AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
-    -   AC6: The application logs a final completion message.
-
----
-
-### Story 5.5: Implement Stage Testing Utility for Emailing
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
--   **Detailed Requirements:**
-    -   Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
-    -   Create a new standalone script file: `src/stages/send_digest.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
-    -   Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
-    -   The script should:
-        -   Initialize logger, load config.
-        -   Determine the target date-stamped directory path (from arg or default). Log the target directory.
-        -   Call `await assembleDigestData(dateDirPath)`.
-        -   If data is assembled and not empty:
-            -   Determine the date string for the subject/title.
-            -   Call `renderDigestHtml(digestData, dateString)` to get HTML.
-            -   Construct the subject string.
-            -   Check the `dryRun` flag:
-                -   If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
-                -   If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
-        -   If data assembly fails or is empty, log the error.
-    -   Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
-    -   AC2: The script `stage:email` is defined in `package.json` allowing arguments.
-    -   AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
-    -   AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
-    -   AC5: The script correctly identifies and acts upon the `--dry-run` flag.
-    -   AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
-    -   AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 5     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/epic5.txt

@@ -1,152 +0,0 @@
-# Epic 5: Digest Assembly & Email Dispatch
-
-**Goal:** Assemble the collected story data and summaries from local files, format them into a readable HTML email digest, and send the email using Nodemailer with configured credentials. Implement a stage testing utility for emailing with a dry-run option.
-
-## Story List
-
-### Story 5.1: Implement Email Content Assembler
-
--   **User Story / Goal:** As a developer, I want a module that reads the persisted story metadata (`_data.json`) and summaries (`_summary.json`) from a specified directory, consolidating the necessary information needed to render the email digest.
--   **Detailed Requirements:**
-    -   Create a new module: `src/email/contentAssembler.ts`.
-    -   Define a TypeScript type/interface `DigestData` representing the data needed per story for the email template: `{ storyId: string, title: string, hnUrl: string, articleUrl: string | null, articleSummary: string | null, discussionSummary: string | null }`.
-    -   Implement an async function `assembleDigestData(dateDirPath: string): Promise<DigestData[]>`.
-    -   The function should:
-        -   Use Node.js `fs` to read the contents of the `dateDirPath`.
-        -   Identify all files matching the pattern `{storyId}_data.json`.
-        -   For each `storyId` found:
-            -   Read and parse the `{storyId}_data.json` file. Extract `title`, `hnUrl`, and `url` (use as `articleUrl`). Handle potential file read/parse errors gracefully (log and skip story).
-            -   Attempt to read and parse the corresponding `{storyId}_summary.json` file. Handle file-not-found or parse errors gracefully (treat `articleSummary` and `discussionSummary` as `null`).
-            -   Construct a `DigestData` object for the story, including the extracted metadata and summaries (or nulls).
-        -   Collect all successfully constructed `DigestData` objects into an array.
-        -   Return the array. It should ideally contain 10 items if all previous stages succeeded.
-    -   Log progress (e.g., "Assembling digest data from directory...", "Processing story {storyId}...") and any errors encountered during file processing using the logger.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The `contentAssembler.ts` module exists and exports `assembleDigestData` and the `DigestData` type.
-    -   AC2: `assembleDigestData` correctly reads `_data.json` files from the provided directory path.
-    -   AC3: It attempts to read corresponding `_summary.json` files, correctly handling cases where the summary file might be missing or unparseable (resulting in null summaries for that story).
-    -   AC4: The function returns a promise resolving to an array of `DigestData` objects, populated with data extracted from the files.
-    -   AC5: Errors during file reading or JSON parsing are logged, and the function returns data for successfully processed stories.
-
----
-
-### Story 5.2: Create HTML Email Template & Renderer
-
--   **User Story / Goal:** As a developer, I want a basic HTML email template and a function to render it with the assembled digest data, producing the final HTML content for the email body.
--   **Detailed Requirements:**
-    -   Define the HTML structure. This can be done using template literals within a function or potentially using a simple template file (e.g., `src/email/templates/digestTemplate.html`) and `fs.readFileSync`. Template literals are simpler for MVP.
-    -   Create a function `renderDigestHtml(data: DigestData[], digestDate: string): string` (e.g., in `src/email/contentAssembler.ts` or a new `templater.ts`).
-    -   The function should generate an HTML string with:
-        -   A suitable title in the body (e.g., `<h1>Hacker News Top 10 Summaries for ${digestDate}</h1>`).
-        -   A loop through the `data` array.
-        -   For each `story` in `data`:
-            -   Display `<h2><a href="${story.articleUrl || story.hnUrl}">${story.title}</a></h2>`.
-            -   Display `<p><a href="${story.hnUrl}">View HN Discussion</a></p>`.
-            -   Conditionally display `<h3>Article Summary</h3><p>${story.articleSummary}</p>` *only if* `story.articleSummary` is not null/empty.
-            -   Conditionally display `<h3>Discussion Summary</h3><p>${story.discussionSummary}</p>` *only if* `story.discussionSummary` is not null/empty.
-            -   Include a separator (e.g., `<hr style="margin-top: 20px; margin-bottom: 20px;">`).
-    -   Use basic inline CSS for minimal styling (margins, etc.) to ensure readability. Avoid complex layouts.
-    -   Return the complete HTML document as a string.
--   **Acceptance Criteria (ACs):**
-    -   AC1: A function `renderDigestHtml` exists that accepts the digest data array and a date string.
-    -   AC2: The function returns a single, complete HTML string.
-    -   AC3: The generated HTML includes a title with the date and correctly iterates through the story data.
-    -   AC4: For each story, the HTML displays the linked title, HN link, and conditionally displays the article and discussion summaries with headings.
-    -   AC5: Basic separators and margins are used for readability. The HTML is simple and likely to render reasonably in most email clients.
-
----
-
-### Story 5.3: Implement Nodemailer Email Sender
-
--   **User Story / Goal:** As a developer, I want a module to send the generated HTML email using Nodemailer, configured with credentials stored securely in the environment file.
--   **Detailed Requirements:**
-    -   Add Nodemailer dependencies: `npm install nodemailer @types/nodemailer --save-prod`.
-    -   Add required configuration variables to `.env.example` (and local `.env`): `EMAIL_HOST`, `EMAIL_PORT` (e.g., 587), `EMAIL_SECURE` (e.g., `false` for STARTTLS on 587, `true` for 465), `EMAIL_USER`, `EMAIL_PASS`, `EMAIL_FROM` (e.g., `"Your Name <you@example.com>"`), `EMAIL_RECIPIENTS` (comma-separated list).
-    -   Create a new module: `src/email/emailSender.ts`.
-    -   Implement an async function `sendDigestEmail(subject: string, htmlContent: string): Promise<boolean>`.
-    -   Inside the function:
-        -   Load the `EMAIL_*` variables from the config module.
-        -   Create a Nodemailer transporter using `nodemailer.createTransport` with the loaded config (host, port, secure flag, auth: { user, pass }).
-        -   Verify transporter configuration using `transporter.verify()` (optional but recommended). Log verification success/failure.
-        -   Parse the `EMAIL_RECIPIENTS` string into an array or comma-separated string suitable for the `to` field.
-        -   Define the `mailOptions`: `{ from: EMAIL_FROM, to: parsedRecipients, subject: subject, html: htmlContent }`.
-        -   Call `await transporter.sendMail(mailOptions)`.
-        -   If `sendMail` succeeds, log the success message including the `messageId` from the result. Return `true`.
-        -   If `sendMail` fails (throws error), log the error using the logger. Return `false`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: `nodemailer` and `@types/nodemailer` dependencies are added.
-    -   AC2: `EMAIL_*` variables are defined in `.env.example` and loaded from config.
-    -   AC3: `emailSender.ts` module exists and exports `sendDigestEmail`.
-    -   AC4: `sendDigestEmail` correctly creates a Nodemailer transporter using configuration from `.env`. Transporter verification is attempted (optional AC).
-    -   AC5: The `to` field is correctly populated based on `EMAIL_RECIPIENTS`.
-    -   AC6: `transporter.sendMail` is called with correct `from`, `to`, `subject`, and `html` options.
-    -   AC7: Email sending success (including message ID) or failure is logged clearly.
-    -   AC8: The function returns `true` on successful sending, `false` otherwise.
-
----
-
-### Story 5.4: Integrate Email Assembly and Sending into Main Workflow
-
--   **User Story / Goal:** As a developer, I want the main application workflow (`src/index.ts`) to orchestrate the final steps: assembling digest data, rendering the HTML, and triggering the email send after all previous stages are complete.
--   **Detailed Requirements:**
-    -   Modify the main execution flow in `src/index.ts`.
-    -   Import `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`.
-    -   Execute these steps *after* the main loop (where stories are fetched, scraped, summarized, and persisted) completes:
-        -   Log "Starting final digest assembly and email dispatch...".
-        -   Determine the path to the current date-stamped output directory.
-        -   Call `const digestData = await assembleDigestData(dateDirPath)`.
-        -   Check if `digestData` array is not empty.
-            -   If yes:
-                -   Get the current date string (e.g., 'YYYY-MM-DD').
-                -   `const htmlContent = renderDigestHtml(digestData, currentDate)`.
-                -   `const subject = \`BMad Hacker Daily Digest - ${currentDate}\``.
-                -   `const emailSent = await sendDigestEmail(subject, htmlContent)`.
-                -   Log the final outcome based on `emailSent` ("Digest email sent successfully." or "Failed to send digest email.").
-            -   If no (`digestData` is empty or assembly failed):
-                -   Log an error: "Failed to assemble digest data or no data found. Skipping email."
-        -   Log "BMad Hacker Daily Digest process finished."
--   **Acceptance Criteria (ACs):**
-    -   AC1: Running `npm run dev` executes all stages (Epics 1-4) and then proceeds to email assembly and sending.
-    -   AC2: `assembleDigestData` is called correctly with the output directory path after other processing is done.
-    -   AC3: If data is assembled, `renderDigestHtml` and `sendDigestEmail` are called with the correct data, subject, and HTML.
-    -   AC4: The final success or failure of the email sending step is logged.
-    -   AC5: If `assembleDigestData` returns no data, email sending is skipped, and an appropriate message is logged.
-    -   AC6: The application logs a final completion message.
-
----
-
-### Story 5.5: Implement Stage Testing Utility for Emailing
-
--   **User Story / Goal:** As a developer, I want a separate script/command to test the email assembly, rendering, and sending logic using persisted local data, including a crucial `--dry-run` option to prevent accidental email sending during tests.
--   **Detailed Requirements:**
-    -   Add `yargs` dependency for argument parsing: `npm install yargs @types/yargs --save-dev`.
-    -   Create a new standalone script file: `src/stages/send_digest.ts`.
-    -   Import necessary modules: `fs`, `path`, `logger`, `config`, `assembleDigestData`, `renderDigestHtml`, `sendDigestEmail`, `yargs`.
-    -   Use `yargs` to parse command-line arguments, specifically looking for a `--dry-run` boolean flag (defaulting to `false`). Allow an optional argument for specifying the date-stamped directory, otherwise default to current date.
-    -   The script should:
-        -   Initialize logger, load config.
-        -   Determine the target date-stamped directory path (from arg or default). Log the target directory.
-        -   Call `await assembleDigestData(dateDirPath)`.
-        -   If data is assembled and not empty:
-            -   Determine the date string for the subject/title.
-            -   Call `renderDigestHtml(digestData, dateString)` to get HTML.
-            -   Construct the subject string.
-            -   Check the `dryRun` flag:
-                -   If `true`: Log "DRY RUN enabled. Skipping actual email send.". Log the subject. Save the `htmlContent` to a file in the target directory (e.g., `_digest_preview.html`). Log that the preview file was saved.
-                -   If `false`: Log "Live run: Attempting to send email...". Call `await sendDigestEmail(subject, htmlContent)`. Log success/failure based on the return value.
-        -   If data assembly fails or is empty, log the error.
-    -   Add script to `package.json`: `"stage:email": "ts-node src/stages/send_digest.ts --"`. The `--` allows passing arguments like `--dry-run`.
--   **Acceptance Criteria (ACs):**
-    -   AC1: The file `src/stages/send_digest.ts` exists. `yargs` dependency is added.
-    -   AC2: The script `stage:email` is defined in `package.json` allowing arguments.
-    -   AC3: Running `npm run stage:email -- --dry-run` reads local data, renders HTML, logs the intent, saves `_digest_preview.html` locally, and does *not* call `sendDigestEmail`.
-    -   AC4: Running `npm run stage:email` (without `--dry-run`) reads local data, renders HTML, and *does* call `sendDigestEmail`, logging the outcome.
-    -   AC5: The script correctly identifies and acts upon the `--dry-run` flag.
-    -   AC6: Logs clearly distinguish between dry runs and live runs and report success/failure.
-    -   AC7: The script operates using only local files and the email configuration/service; it does not invoke prior pipeline stages (Algolia, scraping, Ollama).
-
-## Change Log
-
-| Change        | Date       | Version | Description               | Author         |
-| ------------- | ---------- | ------- | ------------------------- | -------------- |
-| Initial Draft | 2025-05-04 | 0.1     | First draft of Epic 5     | 2-pm           |

V2-FULL-DEMO-WALKTHROUGH/final-brief-with-pm-prompt.md

@@ -1,111 +0,0 @@
-# Project Brief: BMad Hacker Daily Digest
-
-## Introduction / Problem Statement
-
-Hacker News (HN) comment threads contain valuable insights but can be prohibitively long to read thoroughly. The BMad Hacker Daily Digest project aims to solve this by providing a time-efficient way to stay informed about the collective intelligence within HN discussions. The service will automatically fetch the top 10 HN stories daily, retrieve a manageable subset of their comments using the Algolia HN API, generate concise summaries of both the linked article (when possible) and the comment discussion using an LLM, and deliver these summaries in a daily email briefing. This project also serves as a practical learning exercise focused on agent-driven development, TypeScript, Node.js backend services, API integration, and local LLM usage with Ollama.
-
-## Vision & Goals
-
-- **Vision:** To provide a quick, reliable, and automated way for users to stay informed about the key insights and discussions happening within the Hacker News community without needing to read lengthy comment threads.
-- **Primary Goals (MVP - SMART):**
-  - **Fetch HN Story Data:** Successfully retrieve the IDs and metadata (title, URL, HN link) of the top 10 Hacker News stories using the Algolia HN Search API when triggered.
-  - **Retrieve Limited Comments:** For each fetched story, retrieve a predefined, limited set of associated comments using the Algolia HN Search API.
-  - **Attempt Article Scraping:** For each story's external URL, attempt to fetch the raw HTML and extract the main article text using basic methods (Node.js native fetch, article-extractor/Cheerio), handling failures gracefully.
-  - **Generate Summaries (LLM):** Using a local LLM (via Ollama, configured endpoint), generate: an "Article Summary" from scraped text (if successful), and a separate "Discussion Summary" from fetched comments.
-  - **Assemble & Send Digest (Manual Trigger):** Format results for 10 stories into a single HTML email and successfully send it to recipients (list defined in config) using Nodemailer when manually triggered via CLI.
-- **Success Metrics (Initial Ideas for MVP):**
-  - **Successful Execution:** The entire process completes successfully without crashing when manually triggered via CLI for 3 different test runs.
-  - **Digest Content:** The generated email contains results for 10 stories (correct links, discussion summary, article summary where possible). Spot checks confirm relevance.
-  - **Error Handling:** Scraping failures are logged, and the process continues using only comment summaries for affected stories without halting the script.
-
-## Target Audience / Users
-
-**Primary User (MVP):** The developer undertaking this project. The primary motivation is learning and demonstrating agent-driven development, TypeScript, Node.js (v22), API integration (Algolia, LLM, Email), local LLMs (Ollama), and configuration management ( .env ). The key need is an interesting, achievable project scope utilizing these technologies.
-
-**Secondary User (Potential):** Time-constrained HN readers/tech enthusiasts needing automated discussion summaries. Addressing their needs fully is outside MVP scope but informs potential future direction.
-
-## Key Features / Scope (High-Level Ideas for MVP)
-
-- Fetch Top HN Stories (Algolia API).
-- Fetch Limited Comments (Algolia API).
-- Local File Storage (Date-stamped folder, structured text/JSON files).
-- Attempt Basic Article Scraping (Node.js v22 native fetch, basic extraction).
-- Handle Scraping Failures (Log error, proceed with comment-only summary).
-- Generate Summaries (Local Ollama via configured endpoint: Article Summary if scraped, Discussion Summary always).
-- Format Digest Email (HTML: Article Summary (opt.), Discussion Summary, HN link, Article link).
-- Manual Email Dispatch (Nodemailer, credentials from .env , recipient list from .env ).
-- CLI Trigger (Manual command to run full process).
-
-**Explicitly OUT of Scope for MVP:** Advanced scraping (JS render, anti-bot), processing _all_ comments/MapReduce summaries, automated scheduling (cron), database integration, cloud deployment/web frontend, user management (sign-ups etc.), production-grade error handling/monitoring/deliverability, fine-tuning LLM prompts, sophisticated retry logic.
-
-## Known Technical Constraints or Preferences
-
-- **Constraints/Preferences:**
-
-  - **Language/Runtime:** TypeScript running on Node.js v22.
-  - **Execution Environment:** Local machine execution for MVP.
-  - **Trigger Mechanism:** Manual CLI trigger only for MVP.
-  - **Configuration Management:** Use a `.env` file for configuration: LLM endpoint URL, email credentials, recipient email list, potentially comment fetch limits etc.
-  - **HTTP Requests:** Use Node.js v22 native fetch API (no Axios).
-  - **HN Data Source:** Algolia HN Search API.
-  - **Web Scraping:** Basic, best-effort only (native fetch + static HTML extraction). Must handle failures gracefully.
-  - **LLM Integration:** Local Ollama via configurable endpoint for MVP. Design for potential swap to cloud LLMs. Functionality over quality for MVP.
-  - **Summarization Strategy:** Separate Article/Discussion summaries. Limit comments processed per story (configurable). No MapReduce.
-  - **Data Storage:** Local file system (structured text/JSON in date-stamped folders). No database.
-  - **Email Delivery:** Nodemailer. Read credentials and recipient list from `.env`. Basic setup, no production deliverability focus.
-  - **Primary Goal Context:** Focus on functional pipeline for learning/demonstration.
-
-- **Risks:**
-  - Algolia HN API Issues: Changes, rate limits, availability.
-  - Web Scraping Fragility: High likelihood of failure limiting Article Summaries.
-  - LLM Variability & Quality: Inconsistent performance/quality from local Ollama; potential errors.
-    *Incomplete Discussion Capture: Limited comment fetching may miss key insights.
-    *Email Configuration/Deliverability: Fragility of personal credentials; potential spam filtering.
-    *Manual Trigger Dependency: Digest only generated on manual execution.
-    *Configuration Errors: Incorrect `.env` settings could break the application.
-    _(User Note: Risks acknowledged and accepted given the project's learning goals.)_
-
-## Relevant Research (Optional)
-
-Feasibility: Core concept confirmed technically feasible with available APIs/libraries.
-Existing Tools & Market Context: Similar tools exist (validating interest), but daily email format appears distinct.
-API Selection: Algolia HN Search API chosen for filtering/sorting capabilities.
-Identified Technical Challenges: Confirmed complexities of scraping and handling large comment volumes within LLM limits, informing MVP scope.
-Local LLM Viability: Ollama confirmed as viable for local MVP development/testing, with potential for future swapping.
-
-## PM Prompt
-
-**PM Agent Handoff Prompt: BMad Hacker Daily Digest**
-
-**Summary of Key Insights:**
-
-This Project Brief outlines the "BMad Hacker Daily Digest," a command-line tool designed to provide daily email summaries of discussions from top Hacker News (HN) comment threads. The core problem is the time required to read lengthy but valuable HN discussions. The MVP aims to fetch the top 10 HN stories, retrieve a limited set of comments via the Algolia HN API, attempt basic scraping of linked articles (with fallback), generate separate summaries for articles (if scraped) and comments using a local LLM (Ollama), and email the digest to the developer using Nodemailer. This project primarily serves as a learning exercise and demonstration of agent-driven development in TypeScript.
-
-**Areas Requiring Special Attention (for PRD):**
-
-- **Comment Selection Logic:** Define the specific criteria for selecting the "limited set" of comments from Algolia (e.g., number of comments, recency, token count limit).
-- **Basic Scraping Implementation:** Detail the exact steps for the basic article scraping attempt (libraries like Node.js native fetch, article-extractor/Cheerio), including specific error handling and the fallback mechanism.
-- **LLM Prompting:** Define the precise prompts for generating the "Article Summary" and the "Discussion Summary" separately.
-- **Email Formatting:** Specify the exact structure, layout, and content presentation within the daily HTML email digest.
-- **CLI Interface:** Define the specific command(s), arguments, and expected output/feedback for the manual trigger.
-- **Local File Structure:** Define the structure for storing intermediate data and logs in local text files within date-stamped folders.
-
-**Development Context:**
-
-This brief was developed through iterative discussion, starting from general app ideas and refining scope based on user interest (HN discussions) and technical feasibility for a learning/demo project. Key decisions include prioritizing comment summarization, using the Algolia HN API, starting with local execution (Ollama, Nodemailer), and including only a basic, best-effort scraping attempt in the MVP.
-
-**Guidance on PRD Detail:**
-
-- Focus detailed requirements and user stories on the core data pipeline: HN API Fetch -> Comment Selection -> Basic Scrape Attempt -> LLM Summarization (x2) -> Email Formatting/Sending -> CLI Trigger.
-- Keep potential post-MVP enhancements (cloud deployment, frontend, database, advanced scraping, scheduling) as high-level future considerations.
-- Technical implementation details for API/LLM interaction should allow flexibility for potential future swapping (e.g., Ollama to cloud LLM).
-
-**User Preferences:**
-
-- Execution: Manual CLI trigger for MVP.
-- Data Storage: Local text files for MVP.
-- LLM: Ollama for local development/MVP. Ability to potentially switch to cloud API later.
-- Summaries: Generate separate summaries for article (if available) and comments.
-- API: Use Algolia HN Search API.
-- Email: Use Nodemailer for self-send in MVP.
-- Tech Stack: TypeScript, Node.js v22.

V2-FULL-DEMO-WALKTHROUGH/final-brief-with-pm-prompt.txt

@@ -1,111 +0,0 @@
-# Project Brief: BMad Hacker Daily Digest
-
-## Introduction / Problem Statement
-
-Hacker News (HN) comment threads contain valuable insights but can be prohibitively long to read thoroughly. The BMad Hacker Daily Digest project aims to solve this by providing a time-efficient way to stay informed about the collective intelligence within HN discussions. The service will automatically fetch the top 10 HN stories daily, retrieve a manageable subset of their comments using the Algolia HN API, generate concise summaries of both the linked article (when possible) and the comment discussion using an LLM, and deliver these summaries in a daily email briefing. This project also serves as a practical learning exercise focused on agent-driven development, TypeScript, Node.js backend services, API integration, and local LLM usage with Ollama.
-
-## Vision & Goals
-
-- **Vision:** To provide a quick, reliable, and automated way for users to stay informed about the key insights and discussions happening within the Hacker News community without needing to read lengthy comment threads.
-- **Primary Goals (MVP - SMART):**
-  - **Fetch HN Story Data:** Successfully retrieve the IDs and metadata (title, URL, HN link) of the top 10 Hacker News stories using the Algolia HN Search API when triggered.
-  - **Retrieve Limited Comments:** For each fetched story, retrieve a predefined, limited set of associated comments using the Algolia HN Search API.
-  - **Attempt Article Scraping:** For each story's external URL, attempt to fetch the raw HTML and extract the main article text using basic methods (Node.js native fetch, article-extractor/Cheerio), handling failures gracefully.
-  - **Generate Summaries (LLM):** Using a local LLM (via Ollama, configured endpoint), generate: an "Article Summary" from scraped text (if successful), and a separate "Discussion Summary" from fetched comments.
-  - **Assemble & Send Digest (Manual Trigger):** Format results for 10 stories into a single HTML email and successfully send it to recipients (list defined in config) using Nodemailer when manually triggered via CLI.
-- **Success Metrics (Initial Ideas for MVP):**
-  - **Successful Execution:** The entire process completes successfully without crashing when manually triggered via CLI for 3 different test runs.
-  - **Digest Content:** The generated email contains results for 10 stories (correct links, discussion summary, article summary where possible). Spot checks confirm relevance.
-  - **Error Handling:** Scraping failures are logged, and the process continues using only comment summaries for affected stories without halting the script.
-
-## Target Audience / Users
-
-**Primary User (MVP):** The developer undertaking this project. The primary motivation is learning and demonstrating agent-driven development, TypeScript, Node.js (v22), API integration (Algolia, LLM, Email), local LLMs (Ollama), and configuration management ( .env ). The key need is an interesting, achievable project scope utilizing these technologies.
-
-**Secondary User (Potential):** Time-constrained HN readers/tech enthusiasts needing automated discussion summaries. Addressing their needs fully is outside MVP scope but informs potential future direction.
-
-## Key Features / Scope (High-Level Ideas for MVP)
-
-- Fetch Top HN Stories (Algolia API).
-- Fetch Limited Comments (Algolia API).
-- Local File Storage (Date-stamped folder, structured text/JSON files).
-- Attempt Basic Article Scraping (Node.js v22 native fetch, basic extraction).
-- Handle Scraping Failures (Log error, proceed with comment-only summary).
-- Generate Summaries (Local Ollama via configured endpoint: Article Summary if scraped, Discussion Summary always).
-- Format Digest Email (HTML: Article Summary (opt.), Discussion Summary, HN link, Article link).
-- Manual Email Dispatch (Nodemailer, credentials from .env , recipient list from .env ).
-- CLI Trigger (Manual command to run full process).
-
-**Explicitly OUT of Scope for MVP:** Advanced scraping (JS render, anti-bot), processing _all_ comments/MapReduce summaries, automated scheduling (cron), database integration, cloud deployment/web frontend, user management (sign-ups etc.), production-grade error handling/monitoring/deliverability, fine-tuning LLM prompts, sophisticated retry logic.
-
-## Known Technical Constraints or Preferences
-
-- **Constraints/Preferences:**
-
-  - **Language/Runtime:** TypeScript running on Node.js v22.
-  - **Execution Environment:** Local machine execution for MVP.
-  - **Trigger Mechanism:** Manual CLI trigger only for MVP.
-  - **Configuration Management:** Use a `.env` file for configuration: LLM endpoint URL, email credentials, recipient email list, potentially comment fetch limits etc.
-  - **HTTP Requests:** Use Node.js v22 native fetch API (no Axios).
-  - **HN Data Source:** Algolia HN Search API.
-  - **Web Scraping:** Basic, best-effort only (native fetch + static HTML extraction). Must handle failures gracefully.
-  - **LLM Integration:** Local Ollama via configurable endpoint for MVP. Design for potential swap to cloud LLMs. Functionality over quality for MVP.
-  - **Summarization Strategy:** Separate Article/Discussion summaries. Limit comments processed per story (configurable). No MapReduce.
-  - **Data Storage:** Local file system (structured text/JSON in date-stamped folders). No database.
-  - **Email Delivery:** Nodemailer. Read credentials and recipient list from `.env`. Basic setup, no production deliverability focus.
-  - **Primary Goal Context:** Focus on functional pipeline for learning/demonstration.
-
-- **Risks:**
-  - Algolia HN API Issues: Changes, rate limits, availability.
-  - Web Scraping Fragility: High likelihood of failure limiting Article Summaries.
-  - LLM Variability & Quality: Inconsistent performance/quality from local Ollama; potential errors.
-    *Incomplete Discussion Capture: Limited comment fetching may miss key insights.
-    *Email Configuration/Deliverability: Fragility of personal credentials; potential spam filtering.
-    *Manual Trigger Dependency: Digest only generated on manual execution.
-    *Configuration Errors: Incorrect `.env` settings could break the application.
-    _(User Note: Risks acknowledged and accepted given the project's learning goals.)_
-
-## Relevant Research (Optional)
-
-Feasibility: Core concept confirmed technically feasible with available APIs/libraries.
-Existing Tools & Market Context: Similar tools exist (validating interest), but daily email format appears distinct.
-API Selection: Algolia HN Search API chosen for filtering/sorting capabilities.
-Identified Technical Challenges: Confirmed complexities of scraping and handling large comment volumes within LLM limits, informing MVP scope.
-Local LLM Viability: Ollama confirmed as viable for local MVP development/testing, with potential for future swapping.
-
-## PM Prompt
-
-**PM Agent Handoff Prompt: BMad Hacker Daily Digest**
-
-**Summary of Key Insights:**
-
-This Project Brief outlines the "BMad Hacker Daily Digest," a command-line tool designed to provide daily email summaries of discussions from top Hacker News (HN) comment threads. The core problem is the time required to read lengthy but valuable HN discussions. The MVP aims to fetch the top 10 HN stories, retrieve a limited set of comments via the Algolia HN API, attempt basic scraping of linked articles (with fallback), generate separate summaries for articles (if scraped) and comments using a local LLM (Ollama), and email the digest to the developer using Nodemailer. This project primarily serves as a learning exercise and demonstration of agent-driven development in TypeScript.
-
-**Areas Requiring Special Attention (for PRD):**
-
-- **Comment Selection Logic:** Define the specific criteria for selecting the "limited set" of comments from Algolia (e.g., number of comments, recency, token count limit).
-- **Basic Scraping Implementation:** Detail the exact steps for the basic article scraping attempt (libraries like Node.js native fetch, article-extractor/Cheerio), including specific error handling and the fallback mechanism.
-- **LLM Prompting:** Define the precise prompts for generating the "Article Summary" and the "Discussion Summary" separately.
-- **Email Formatting:** Specify the exact structure, layout, and content presentation within the daily HTML email digest.
-- **CLI Interface:** Define the specific command(s), arguments, and expected output/feedback for the manual trigger.
-- **Local File Structure:** Define the structure for storing intermediate data and logs in local text files within date-stamped folders.
-
-**Development Context:**
-
-This brief was developed through iterative discussion, starting from general app ideas and refining scope based on user interest (HN discussions) and technical feasibility for a learning/demo project. Key decisions include prioritizing comment summarization, using the Algolia HN API, starting with local execution (Ollama, Nodemailer), and including only a basic, best-effort scraping attempt in the MVP.
-
-**Guidance on PRD Detail:**
-
-- Focus detailed requirements and user stories on the core data pipeline: HN API Fetch -> Comment Selection -> Basic Scrape Attempt -> LLM Summarization (x2) -> Email Formatting/Sending -> CLI Trigger.
-- Keep potential post-MVP enhancements (cloud deployment, frontend, database, advanced scraping, scheduling) as high-level future considerations.
-- Technical implementation details for API/LLM interaction should allow flexibility for potential future swapping (e.g., Ollama to cloud LLM).
-
-**User Preferences:**
-
-- Execution: Manual CLI trigger for MVP.
-- Data Storage: Local text files for MVP.
-- LLM: Ollama for local development/MVP. Ability to potentially switch to cloud API later.
-- Summaries: Generate separate summaries for article (if available) and comments.
-- API: Use Algolia HN Search API.
-- Email: Use Nodemailer for self-send in MVP.
-- Tech Stack: TypeScript, Node.js v22.

V2-FULL-DEMO-WALKTHROUGH/prd.md

@@ -1,189 +0,0 @@
-# BMad Hacker Daily Digest Product Requirements Document (PRD)
-
-## Intro
-
-The BMad Hacker Daily Digest is a command-line tool designed to address the time-consuming nature of reading extensive Hacker News (HN) comment threads. It aims to provide users with a time-efficient way to grasp the collective intelligence and key insights from discussions on top HN stories. The service will fetch the top 10 HN stories daily, retrieve a configurable number of comments for each, attempt to scrape the linked article, generate separate summaries for the article (if scraped) and the comment discussion using a local LLM, and deliver these summaries in a single daily email briefing triggered manually. This project also serves as a practical learning exercise in agent-driven development, TypeScript, Node.js, API integration, and local LLM usage, starting from the provided "bmad-boilerplate" template.
-
-## Goals and Context
-
-- **Project Objectives:**
-  - Provide a quick, reliable, automated way to stay informed about key HN discussions without reading full threads.
-  - Successfully fetch top 10 HN story metadata via Algolia HN API.
-  - Retrieve a _configurable_ number of comments per story (default 50) via Algolia HN API.
-  - Attempt basic scraping of linked article content, handling failures gracefully.
-  - Generate distinct Article Summaries (if scraped) and Discussion Summaries using a local LLM (Ollama).
-  - Assemble summaries for 10 stories into an HTML email and send via Nodemailer upon manual CLI trigger.
-  - Serve as a learning platform for agent-driven development, TypeScript, Node.js v22, API integration, local LLMs, and configuration management, leveraging the "bmad-boilerplate" structure and tooling.
-- **Measurable Outcomes:**
-  - The tool completes its full process (fetch, scrape attempt, summarize, email) without crashing on manual CLI trigger across multiple test runs.
-  - The generated email digest consistently contains results for 10 stories, including correct links, discussion summaries, and article summaries where scraping was successful.
-  - Errors during article scraping are logged, and the process continues for affected stories using only comment summaries, without halting the script.
-- **Success Criteria:**
-  - Successful execution of the end-to-end process via CLI trigger for 3 consecutive test runs.
-  - Generated email is successfully sent and received, containing summaries for all 10 fetched stories (article summary optional based on scraping success).
-  - Scraping failures are logged appropriately without stopping the overall process.
-- **Key Performance Indicators (KPIs):**
-  - Successful Runs / Total Runs (Target: 100% for MVP tests)
-  - Stories with Article Summaries / Total Stories (Measures scraping effectiveness)
-  - Stories with Discussion Summaries / Total Stories (Target: 100%)
-  * Manual Qualitative Check: Relevance and coherence of summaries in the digest.
-
-## Scope and Requirements (MVP / Current Version)
-
-### Functional Requirements (High-Level)
-
-- **HN Story Fetching:** Retrieve IDs and metadata (title, URL, HN link) for the top 10 stories from Algolia HN Search API.
-- **HN Comment Fetching:** For each story, retrieve comments from Algolia HN Search API up to a maximum count defined in a `.env` configuration variable (`MAX_COMMENTS_PER_STORY`, default 50).
-- **Article Content Scraping:** Attempt to fetch HTML and extract main text content from the story's external URL using basic methods (e.g., Node.js native fetch, optionally `article-extractor` or similar basic library).
-- **Scraping Failure Handling:** If scraping fails, log the error and proceed with generating only the Discussion Summary for that story.
-- **LLM Summarization:**
-  - Generate an "Article Summary" from scraped text (if successful) using a configured local LLM (Ollama endpoint).
-  - Generate a "Discussion Summary" from the fetched comments using the same LLM.
-  - Initial Prompts (Placeholders - refine in Epics):
-    - _Article Prompt:_ "Summarize the key points of the following article text: {Article Text}"
-    - _Discussion Prompt:_ "Summarize the main themes, viewpoints, and key insights from the following Hacker News comments: {Comment Texts}"
-- **Digest Formatting:** Combine results for the 10 stories into a single HTML email. Each story entry should include: Story Title, HN Link, Article Link, Article Summary (if available), Discussion Summary.
-- **Email Dispatch:** Send the formatted HTML email using Nodemailer to a recipient list defined in `.env`. Use credentials also stored in `.env`.
-- **Main Execution Trigger:** Initiate the _entire implemented pipeline_ via a manual command-line interface (CLI) trigger, using the standard scripts defined in the boilerplate (`npm run dev`, `npm start` after build). Each functional epic should add its capability to this main execution flow.
-- **Configuration:** Manage external parameters (Algolia API details (if needed), LLM endpoint URL, `MAX_COMMENTS_PER_STORY`, Nodemailer credentials, recipient email list, output directory path) via a `.env` file, based on the provided `.env.example`.
-- **Incremental Logging & Data Persistence:**
-  - Implement basic console logging for key steps and errors throughout the pipeline.
-  - Persist intermediate data artifacts (fetched stories/comments, scraped text, generated summaries) to local files within a configurable, date-stamped directory structure (e.g., `./output/YYYY-MM-DD/`).
-  - This persistence should be implemented incrementally within the relevant functional epics (Data Acquisition, Scraping, Summarization).
-- **Stage Testing Utilities:**
-  - Provide separate utility scripts or CLI commands to allow testing individual pipeline stages in isolation (e.g., fetching HN data, scraping URLs, summarizing text, sending email).
-  - These utilities should support using locally saved files as input (e.g., test scraping using a file containing story URLs, test summarization using a file containing text). This facilitates development and debugging.
-
-### Non-Functional Requirements (NFRs)
-
-- **Performance:** MVP focuses on functionality over speed. Should complete within a reasonable time (e.g., < 5 minutes) on a typical developer machine for local LLM use. No specific response time targets.
-- **Scalability:** Designed for single-user, local execution. No scaling requirements for MVP.
-- **Reliability/Availability:**
-  - The script must handle article scraping failures gracefully (log and continue).
-  - Basic error handling for API calls (e.g., log network errors).
-  - Local LLM interaction may fail; basic error logging is sufficient for MVP.
-  - No requirement for automated retries or production-grade error handling.
-- **Security:**
-  - Email credentials must be stored securely via `.env` file and not committed to version control (as per boilerplate `.gitignore`).
-  - No other specific security requirements for local MVP.
-- **Maintainability:**
-  - Code should be well-structured TypeScript.
-  - Adherence to the linting (ESLint) and formatting (Prettier) rules configured in the "bmad-boilerplate" is required. Use `npm run lint` and `npm run format`.
-  - Modularity is desired to potentially swap LLM providers later and facilitate stage testing.
-- **Usability/Accessibility:** N/A (CLI tool for developer).
-- **Other Constraints:**
-  - Must use TypeScript and Node.js v22.
-  - Must run locally on the developer's machine.
-  - Must use Node.js v22 native `Workspace` API for HTTP requests.
-  - Must use Algolia HN Search API for HN data.
-  - Must use a local Ollama instance via a configurable HTTP endpoint.
-  - Must use Nodemailer for email dispatch.
-  - Must use `.env` for configuration based on `.env.example`.
-  - Must use local file system for logging and intermediate data storage. Ensure output/log directories are gitignored.
-  - Focus on a functional pipeline for learning/demonstration.
-
-### User Experience (UX) Requirements (High-Level)
-
-- The primary UX goal is to deliver a time-saving digest.
-- For the developer user, the main CLI interaction should be simple: using standard boilerplate scripts like `npm run dev` or `npm start` to trigger the full process.
-- Feedback during CLI execution (e.g., "Fetching stories...", "Summarizing story X/10...", "Sending email...") is desirable via console logging.
-- Separate CLI commands/scripts for testing individual stages should provide clear input/output mechanisms.
-
-### Integration Requirements (High-Level)
-
-- **Algolia HN Search API:** Fetching top stories and comments. Requires understanding API structure and query parameters.
-- **Ollama Service:** Sending text (article content, comments) and receiving summaries via its API endpoint. Endpoint URL must be configurable.
-- **SMTP Service (via Nodemailer):** Sending the final digest email. Requires valid SMTP credentials and recipient list configured in `.env`.
-
-### Testing Requirements (High-Level)
-
-- MVP success relies on manual end-to-end test runs confirming successful execution and valid email output.
-- Unit/integration tests are encouraged using the **Jest framework configured in the boilerplate**. Focus testing effort on the core pipeline components. Use `npm run test`.
-- **Stage-specific testing utilities (as defined in Functional Requirements) are required** to support development and verification of individual pipeline components.
-
-## Epic Overview (MVP / Current Version)
-
-_(Revised proposal)_
-
-- **Epic 1: Project Initialization & Core Setup** - Goal: Initialize the project using "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure.
-- **Epic 2: HN Data Acquisition & Persistence** - Goal: Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally. Implement stage testing utility for fetching.
-- **Epic 3: Article Scraping & Persistence** - Goal: Implement best-effort article scraping/extraction, handle failures gracefully, and persist scraped text locally. Implement stage testing utility for scraping.
-- **Epic 4: LLM Summarization & Persistence** - Goal: Integrate with Ollama to generate article/discussion summaries from persisted data and persist summaries locally. Implement stage testing utility for summarization.
-- **Epic 5: Digest Assembly & Email Dispatch** - Goal: Format collected summaries into an HTML email using persisted data and send it using Nodemailer. Implement stage testing utility for emailing (with dry-run option).
-
-## Key Reference Documents
-
-- `docs/project-brief.md`
-- `docs/prd.md` (This document)
-- `docs/architecture.md` (To be created by Architect)
-- `docs/epic1.md`, `docs/epic2.md`, ... (To be created)
-- `docs/tech-stack.md` (Partially defined by boilerplate, to be finalized by Architect)
-- `docs/api-reference.md` (If needed for Algolia/Ollama details)
-- `docs/testing-strategy.md` (Optional - low priority for MVP, Jest setup provided)
-
-## Post-MVP / Future Enhancements
-
-- Advanced scraping techniques (handling JavaScript, anti-bot measures).
-- Processing all comments (potentially using MapReduce summarization).
-- Automated scheduling (e.g., using cron).
-- Database integration for storing results or tracking.
-- Cloud deployment and web frontend.
-- User management (sign-ups, preferences).
-- Production-grade error handling, monitoring, and email deliverability.
-- Fine-tuning LLM prompts or models.
-- Sophisticated retry logic for API calls or scraping.
-- Cloud LLM integration.
-
-## Change Log
-
-| Change                  | Date       | Version | Description                             | Author |
-| ----------------------- | ---------- | ------- | --------------------------------------- | ------ |
-| Refined Epics & Testing | 2025-05-04 | 0.3     | Removed Epic 6, added stage testing req | 2-pm   |
-| Boilerplate Added       | 2025-05-04 | 0.2     | Updated to reflect use of boilerplate   | 2-pm   |
-| Initial Draft           | 2025-05-04 | 0.1     | First draft based on brief              | 2-pm   |
-
-## Initial Architect Prompt
-
-### Technical Infrastructure
-
-- **Starter Project/Template:** **Mandatory: Use the provided "bmad-boilerplate".** This includes TypeScript setup, Node.js v22 compatibility, Jest, ESLint, Prettier, `ts-node`, `.env` handling via `.env.example`, and standard scripts (`dev`, `build`, `test`, `lint`, `format`).
-- **Hosting/Cloud Provider:** Local machine execution only for MVP. No cloud deployment.
-- **Frontend Platform:** N/A (CLI tool).
-- **Backend Platform:** Node.js v22 with TypeScript (as provided by the boilerplate). No specific Node.js framework mandated, but structure should support modularity and align with boilerplate setup.
-- **Database Requirements:** None. Local file system for intermediate data storage and logging only. Structure TBD (e.g., `./output/YYYY-MM-DD/`). Ensure output directory is configurable via `.env` and gitignored.
-
-### Technical Constraints
-
-- Must adhere to the structure and tooling provided by "bmad-boilerplate".
-- Must use Node.js v22 native `Workspace` for HTTP requests.
-- Must use the Algolia HN Search API for fetching HN data.
-- Must integrate with a local Ollama instance via a configurable HTTP endpoint. Design should allow potential swapping to other LLM APIs later.
-- Must use Nodemailer for sending email.
-- Configuration (LLM endpoint, email credentials, recipients, `MAX_COMMENTS_PER_STORY`, output dir path) must be managed via a `.env` file based on `.env.example`.
-- Article scraping must be basic, best-effort, and handle failures gracefully without stopping the main process.
-- Intermediate data must be persisted locally incrementally.
-- Code must adhere to the ESLint and Prettier configurations within the boilerplate.
-
-### Deployment Considerations
-
-- Execution is manual via CLI trigger only, using `npm run dev` or `npm start`.
-- No CI/CD required for MVP.
-- Single environment: local development machine.
-
-### Local Development & Testing Requirements
-
-- The entire application runs locally.
-- The main CLI command (`npm run dev`/`start`) should execute the _full implemented pipeline_.
-- **Separate utility scripts/commands MUST be provided** for testing individual pipeline stages (fetch, scrape, summarize, email) potentially using local file I/O. Architecture should facilitate creating these stage runners. (e.g., `npm run stage:fetch`, `npm run stage:scrape -- --inputFile <path>`, `npm run stage:summarize -- --inputFile <path>`, `npm run stage:email -- --inputFile <path> [--dry-run]`).
-- The boilerplate provides `npm run test` using Jest for running automated unit/integration tests.
-- The boilerplate provides `npm run lint` and `npm run format` for code quality checks.
-- Basic console logging is required. File logging can be considered by the architect.
-- Testability of individual modules (API clients, scraper, summarizer, emailer) is crucial and should leverage the Jest setup and stage testing utilities.
-
-### Other Technical Considerations
-
-- **Modularity:** Design components (HN client, scraper, LLM client, emailer) with clear interfaces to facilitate potential future modifications (e.g., changing LLM provider) and independent stage testing.
-- **Error Handling:** Focus on robust handling of scraping failures and basic handling of API/network errors. Implement within the boilerplate structure. Logging should clearly indicate errors.
-- **Resource Management:** Be mindful of local resources when interacting with the LLM, although optimization is not a primary MVP goal.
-- **Dependency Management:** Add necessary production dependencies (e.g., `nodemailer`, potentially `article-extractor`, libraries for date handling or file system operations if needed) to the boilerplate's `package.json`. Keep dependencies minimal.
-- **Configuration Loading:** Implement a robust way to load and validate settings from the `.env` file early in the application startup.

V2-FULL-DEMO-WALKTHROUGH/prd.txt

@@ -1,189 +0,0 @@
-# BMad Hacker Daily Digest Product Requirements Document (PRD)
-
-## Intro
-
-The BMad Hacker Daily Digest is a command-line tool designed to address the time-consuming nature of reading extensive Hacker News (HN) comment threads. It aims to provide users with a time-efficient way to grasp the collective intelligence and key insights from discussions on top HN stories. The service will fetch the top 10 HN stories daily, retrieve a configurable number of comments for each, attempt to scrape the linked article, generate separate summaries for the article (if scraped) and the comment discussion using a local LLM, and deliver these summaries in a single daily email briefing triggered manually. This project also serves as a practical learning exercise in agent-driven development, TypeScript, Node.js, API integration, and local LLM usage, starting from the provided "bmad-boilerplate" template.
-
-## Goals and Context
-
-- **Project Objectives:**
-  - Provide a quick, reliable, automated way to stay informed about key HN discussions without reading full threads.
-  - Successfully fetch top 10 HN story metadata via Algolia HN API.
-  - Retrieve a _configurable_ number of comments per story (default 50) via Algolia HN API.
-  - Attempt basic scraping of linked article content, handling failures gracefully.
-  - Generate distinct Article Summaries (if scraped) and Discussion Summaries using a local LLM (Ollama).
-  - Assemble summaries for 10 stories into an HTML email and send via Nodemailer upon manual CLI trigger.
-  - Serve as a learning platform for agent-driven development, TypeScript, Node.js v22, API integration, local LLMs, and configuration management, leveraging the "bmad-boilerplate" structure and tooling.
-- **Measurable Outcomes:**
-  - The tool completes its full process (fetch, scrape attempt, summarize, email) without crashing on manual CLI trigger across multiple test runs.
-  - The generated email digest consistently contains results for 10 stories, including correct links, discussion summaries, and article summaries where scraping was successful.
-  - Errors during article scraping are logged, and the process continues for affected stories using only comment summaries, without halting the script.
-- **Success Criteria:**
-  - Successful execution of the end-to-end process via CLI trigger for 3 consecutive test runs.
-  - Generated email is successfully sent and received, containing summaries for all 10 fetched stories (article summary optional based on scraping success).
-  - Scraping failures are logged appropriately without stopping the overall process.
-- **Key Performance Indicators (KPIs):**
-  - Successful Runs / Total Runs (Target: 100% for MVP tests)
-  - Stories with Article Summaries / Total Stories (Measures scraping effectiveness)
-  - Stories with Discussion Summaries / Total Stories (Target: 100%)
-  * Manual Qualitative Check: Relevance and coherence of summaries in the digest.
-
-## Scope and Requirements (MVP / Current Version)
-
-### Functional Requirements (High-Level)
-
-- **HN Story Fetching:** Retrieve IDs and metadata (title, URL, HN link) for the top 10 stories from Algolia HN Search API.
-- **HN Comment Fetching:** For each story, retrieve comments from Algolia HN Search API up to a maximum count defined in a `.env` configuration variable (`MAX_COMMENTS_PER_STORY`, default 50).
-- **Article Content Scraping:** Attempt to fetch HTML and extract main text content from the story's external URL using basic methods (e.g., Node.js native fetch, optionally `article-extractor` or similar basic library).
-- **Scraping Failure Handling:** If scraping fails, log the error and proceed with generating only the Discussion Summary for that story.
-- **LLM Summarization:**
-  - Generate an "Article Summary" from scraped text (if successful) using a configured local LLM (Ollama endpoint).
-  - Generate a "Discussion Summary" from the fetched comments using the same LLM.
-  - Initial Prompts (Placeholders - refine in Epics):
-    - _Article Prompt:_ "Summarize the key points of the following article text: {Article Text}"
-    - _Discussion Prompt:_ "Summarize the main themes, viewpoints, and key insights from the following Hacker News comments: {Comment Texts}"
-- **Digest Formatting:** Combine results for the 10 stories into a single HTML email. Each story entry should include: Story Title, HN Link, Article Link, Article Summary (if available), Discussion Summary.
-- **Email Dispatch:** Send the formatted HTML email using Nodemailer to a recipient list defined in `.env`. Use credentials also stored in `.env`.
-- **Main Execution Trigger:** Initiate the _entire implemented pipeline_ via a manual command-line interface (CLI) trigger, using the standard scripts defined in the boilerplate (`npm run dev`, `npm start` after build). Each functional epic should add its capability to this main execution flow.
-- **Configuration:** Manage external parameters (Algolia API details (if needed), LLM endpoint URL, `MAX_COMMENTS_PER_STORY`, Nodemailer credentials, recipient email list, output directory path) via a `.env` file, based on the provided `.env.example`.
-- **Incremental Logging & Data Persistence:**
-  - Implement basic console logging for key steps and errors throughout the pipeline.
-  - Persist intermediate data artifacts (fetched stories/comments, scraped text, generated summaries) to local files within a configurable, date-stamped directory structure (e.g., `./output/YYYY-MM-DD/`).
-  - This persistence should be implemented incrementally within the relevant functional epics (Data Acquisition, Scraping, Summarization).
-- **Stage Testing Utilities:**
-  - Provide separate utility scripts or CLI commands to allow testing individual pipeline stages in isolation (e.g., fetching HN data, scraping URLs, summarizing text, sending email).
-  - These utilities should support using locally saved files as input (e.g., test scraping using a file containing story URLs, test summarization using a file containing text). This facilitates development and debugging.
-
-### Non-Functional Requirements (NFRs)
-
-- **Performance:** MVP focuses on functionality over speed. Should complete within a reasonable time (e.g., < 5 minutes) on a typical developer machine for local LLM use. No specific response time targets.
-- **Scalability:** Designed for single-user, local execution. No scaling requirements for MVP.
-- **Reliability/Availability:**
-  - The script must handle article scraping failures gracefully (log and continue).
-  - Basic error handling for API calls (e.g., log network errors).
-  - Local LLM interaction may fail; basic error logging is sufficient for MVP.
-  - No requirement for automated retries or production-grade error handling.
-- **Security:**
-  - Email credentials must be stored securely via `.env` file and not committed to version control (as per boilerplate `.gitignore`).
-  - No other specific security requirements for local MVP.
-- **Maintainability:**
-  - Code should be well-structured TypeScript.
-  - Adherence to the linting (ESLint) and formatting (Prettier) rules configured in the "bmad-boilerplate" is required. Use `npm run lint` and `npm run format`.
-  - Modularity is desired to potentially swap LLM providers later and facilitate stage testing.
-- **Usability/Accessibility:** N/A (CLI tool for developer).
-- **Other Constraints:**
-  - Must use TypeScript and Node.js v22.
-  - Must run locally on the developer's machine.
-  - Must use Node.js v22 native `Workspace` API for HTTP requests.
-  - Must use Algolia HN Search API for HN data.
-  - Must use a local Ollama instance via a configurable HTTP endpoint.
-  - Must use Nodemailer for email dispatch.
-  - Must use `.env` for configuration based on `.env.example`.
-  - Must use local file system for logging and intermediate data storage. Ensure output/log directories are gitignored.
-  - Focus on a functional pipeline for learning/demonstration.
-
-### User Experience (UX) Requirements (High-Level)
-
-- The primary UX goal is to deliver a time-saving digest.
-- For the developer user, the main CLI interaction should be simple: using standard boilerplate scripts like `npm run dev` or `npm start` to trigger the full process.
-- Feedback during CLI execution (e.g., "Fetching stories...", "Summarizing story X/10...", "Sending email...") is desirable via console logging.
-- Separate CLI commands/scripts for testing individual stages should provide clear input/output mechanisms.
-
-### Integration Requirements (High-Level)
-
-- **Algolia HN Search API:** Fetching top stories and comments. Requires understanding API structure and query parameters.
-- **Ollama Service:** Sending text (article content, comments) and receiving summaries via its API endpoint. Endpoint URL must be configurable.
-- **SMTP Service (via Nodemailer):** Sending the final digest email. Requires valid SMTP credentials and recipient list configured in `.env`.
-
-### Testing Requirements (High-Level)
-
-- MVP success relies on manual end-to-end test runs confirming successful execution and valid email output.
-- Unit/integration tests are encouraged using the **Jest framework configured in the boilerplate**. Focus testing effort on the core pipeline components. Use `npm run test`.
-- **Stage-specific testing utilities (as defined in Functional Requirements) are required** to support development and verification of individual pipeline components.
-
-## Epic Overview (MVP / Current Version)
-
-_(Revised proposal)_
-
-- **Epic 1: Project Initialization & Core Setup** - Goal: Initialize the project using "bmad-boilerplate", manage dependencies, setup `.env` and config loading, establish basic CLI entry point, setup basic logging and output directory structure.
-- **Epic 2: HN Data Acquisition & Persistence** - Goal: Implement fetching top 10 stories and their comments (respecting limits) from Algolia HN API, and persist this raw data locally. Implement stage testing utility for fetching.
-- **Epic 3: Article Scraping & Persistence** - Goal: Implement best-effort article scraping/extraction, handle failures gracefully, and persist scraped text locally. Implement stage testing utility for scraping.
-- **Epic 4: LLM Summarization & Persistence** - Goal: Integrate with Ollama to generate article/discussion summaries from persisted data and persist summaries locally. Implement stage testing utility for summarization.
-- **Epic 5: Digest Assembly & Email Dispatch** - Goal: Format collected summaries into an HTML email using persisted data and send it using Nodemailer. Implement stage testing utility for emailing (with dry-run option).
-
-## Key Reference Documents
-
-- `docs/project-brief.md`
-- `docs/prd.md` (This document)
-- `docs/architecture.md` (To be created by Architect)
-- `docs/epic1.md`, `docs/epic2.md`, ... (To be created)
-- `docs/tech-stack.md` (Partially defined by boilerplate, to be finalized by Architect)
-- `docs/api-reference.md` (If needed for Algolia/Ollama details)
-- `docs/testing-strategy.md` (Optional - low priority for MVP, Jest setup provided)
-
-## Post-MVP / Future Enhancements
-
-- Advanced scraping techniques (handling JavaScript, anti-bot measures).
-- Processing all comments (potentially using MapReduce summarization).
-- Automated scheduling (e.g., using cron).
-- Database integration for storing results or tracking.
-- Cloud deployment and web frontend.
-- User management (sign-ups, preferences).
-- Production-grade error handling, monitoring, and email deliverability.
-- Fine-tuning LLM prompts or models.
-- Sophisticated retry logic for API calls or scraping.
-- Cloud LLM integration.
-
-## Change Log
-
-| Change                  | Date       | Version | Description                             | Author |
-| ----------------------- | ---------- | ------- | --------------------------------------- | ------ |
-| Refined Epics & Testing | 2025-05-04 | 0.3     | Removed Epic 6, added stage testing req | 2-pm   |
-| Boilerplate Added       | 2025-05-04 | 0.2     | Updated to reflect use of boilerplate   | 2-pm   |
-| Initial Draft           | 2025-05-04 | 0.1     | First draft based on brief              | 2-pm   |
-
-## Initial Architect Prompt
-
-### Technical Infrastructure
-
-- **Starter Project/Template:** **Mandatory: Use the provided "bmad-boilerplate".** This includes TypeScript setup, Node.js v22 compatibility, Jest, ESLint, Prettier, `ts-node`, `.env` handling via `.env.example`, and standard scripts (`dev`, `build`, `test`, `lint`, `format`).
-- **Hosting/Cloud Provider:** Local machine execution only for MVP. No cloud deployment.
-- **Frontend Platform:** N/A (CLI tool).
-- **Backend Platform:** Node.js v22 with TypeScript (as provided by the boilerplate). No specific Node.js framework mandated, but structure should support modularity and align with boilerplate setup.
-- **Database Requirements:** None. Local file system for intermediate data storage and logging only. Structure TBD (e.g., `./output/YYYY-MM-DD/`). Ensure output directory is configurable via `.env` and gitignored.
-
-### Technical Constraints
-
-- Must adhere to the structure and tooling provided by "bmad-boilerplate".
-- Must use Node.js v22 native `Workspace` for HTTP requests.
-- Must use the Algolia HN Search API for fetching HN data.
-- Must integrate with a local Ollama instance via a configurable HTTP endpoint. Design should allow potential swapping to other LLM APIs later.
-- Must use Nodemailer for sending email.
-- Configuration (LLM endpoint, email credentials, recipients, `MAX_COMMENTS_PER_STORY`, output dir path) must be managed via a `.env` file based on `.env.example`.
-- Article scraping must be basic, best-effort, and handle failures gracefully without stopping the main process.
-- Intermediate data must be persisted locally incrementally.
-- Code must adhere to the ESLint and Prettier configurations within the boilerplate.
-
-### Deployment Considerations
-
-- Execution is manual via CLI trigger only, using `npm run dev` or `npm start`.
-- No CI/CD required for MVP.
-- Single environment: local development machine.
-
-### Local Development & Testing Requirements
-
-- The entire application runs locally.
-- The main CLI command (`npm run dev`/`start`) should execute the _full implemented pipeline_.
-- **Separate utility scripts/commands MUST be provided** for testing individual pipeline stages (fetch, scrape, summarize, email) potentially using local file I/O. Architecture should facilitate creating these stage runners. (e.g., `npm run stage:fetch`, `npm run stage:scrape -- --inputFile <path>`, `npm run stage:summarize -- --inputFile <path>`, `npm run stage:email -- --inputFile <path> [--dry-run]`).
-- The boilerplate provides `npm run test` using Jest for running automated unit/integration tests.
-- The boilerplate provides `npm run lint` and `npm run format` for code quality checks.
-- Basic console logging is required. File logging can be considered by the architect.
-- Testability of individual modules (API clients, scraper, summarizer, emailer) is crucial and should leverage the Jest setup and stage testing utilities.
-
-### Other Technical Considerations
-
-- **Modularity:** Design components (HN client, scraper, LLM client, emailer) with clear interfaces to facilitate potential future modifications (e.g., changing LLM provider) and independent stage testing.
-- **Error Handling:** Focus on robust handling of scraping failures and basic handling of API/network errors. Implement within the boilerplate structure. Logging should clearly indicate errors.
-- **Resource Management:** Be mindful of local resources when interacting with the LLM, although optimization is not a primary MVP goal.
-- **Dependency Management:** Add necessary production dependencies (e.g., `nodemailer`, potentially `article-extractor`, libraries for date handling or file system operations if needed) to the boilerplate's `package.json`. Keep dependencies minimal.
-- **Configuration Loading:** Implement a robust way to load and validate settings from the `.env` file early in the application startup.

V2-FULL-DEMO-WALKTHROUGH/project-structure.md

@@ -1,91 +0,0 @@
-# BMad Hacker Daily Digest Project Structure
-
-This document outlines the standard directory and file structure for the project. Adhering to this structure ensures consistency and maintainability.
-
-```plaintext
-bmad-hacker-daily-digest/
-├── .github/                    # Optional: GitHub Actions workflows (if used)
-│   └── workflows/
-├── .vscode/                    # Optional: VSCode editor settings
-│   └── settings.json
-├── dist/                       # Compiled JavaScript output (from 'npm run build', git-ignored)
-├── docs/                       # Project documentation (PRD, Architecture, Epics, etc.)
-│   ├── architecture.md
-│   ├── tech-stack.md
-│   ├── project-structure.md    # This file
-│   ├── data-models.md
-│   ├── api-reference.md
-│   ├── environment-vars.md
-│   ├── coding-standards.md
-│   ├── testing-strategy.md
-│   ├── prd.md                  # Product Requirements Document
-│   ├── epic1.md .. epic5.md    # Epic details
-│   └── ...
-├── node_modules/               # Project dependencies (managed by npm, git-ignored)
-├── output/                     # Default directory for data artifacts (git-ignored)
-│   └── YYYY-MM-DD/             # Date-stamped subdirectories for runs
-│       ├── {storyId}_data.json
-│       ├── {storyId}_article.txt
-│       └── {storyId}_summary.json
-├── src/                        # Application source code
-│   ├── clients/                # Clients for interacting with external services
-│   │   ├── algoliaHNClient.ts  # Algolia HN Search API interaction logic [Epic 2]
-│   │   └── ollamaClient.ts     # Ollama API interaction logic [Epic 4]
-│   ├── core/                   # Core application logic & orchestration
-│   │   └── pipeline.ts         # Main pipeline execution flow (fetch->scrape->summarize->email)
-│   ├── email/                  # Email assembly, templating, and sending logic [Epic 5]
-│   │   ├── contentAssembler.ts # Reads local files, prepares digest data
-│   │   ├── emailSender.ts      # Sends email via Nodemailer
-│   │   └── templates.ts        # HTML email template rendering function(s)
-│   ├── scraper/                # Article scraping logic [Epic 3]
-│   │   └── articleScraper.ts   # Implements scraping using article-extractor
-│   ├── stages/                 # Standalone stage testing utility scripts [PRD Req]
-│   │   ├── fetch_hn_data.ts    # Stage runner for Epic 2
-│   │   ├── scrape_articles.ts  # Stage runner for Epic 3
-│   │   ├── summarize_content.ts# Stage runner for Epic 4
-│   │   └── send_digest.ts      # Stage runner for Epic 5 (with --dry-run)
-│   ├── types/                  # Shared TypeScript interfaces and types
-│   │   ├── hn.ts               # Types: Story, Comment
-│   │   ├── ollama.ts           # Types: OllamaRequest, OllamaResponse
-│   │   ├── email.ts            # Types: DigestData
-│   │   └── index.ts            # Barrel file for exporting types from this dir
-│   ├── utils/                  # Shared, low-level utility functions
-│   │   ├── config.ts           # Loads and validates .env configuration [Epic 1]
-│   │   ├── logger.ts           # Simple console logger wrapper [Epic 1]
-│   │   └── dateUtils.ts        # Date formatting helpers (using date-fns)
-│   └── index.ts                # Main application entry point (invoked by npm run dev/start) [Epic 1]
-├── test/                       # Automated tests (using Jest)
-│   ├── unit/                   # Unit tests (mirroring src structure)
-│   │   ├── clients/
-│   │   ├── core/
-│   │   ├── email/
-│   │   ├── scraper/
-│   │   └── utils/
-│   └── integration/            # Integration tests (e.g., testing pipeline stage interactions)
-├── .env.example                # Example environment variables file [Epic 1]
-├── .gitignore                  # Git ignore rules (ensure node_modules, dist, .env, output/ are included)
-├── package.json                # Project manifest, dependencies, scripts (from boilerplate)
-├── package-lock.json           # Lockfile for deterministic installs
-└── tsconfig.json               # TypeScript compiler configuration (from boilerplate)
-```
-
-## Key Directory Descriptions
-
-- `docs/`: Contains all project planning, architecture, and reference documentation.
-- `output/`: Default location for persisted data artifacts generated during runs (stories, comments, summaries). Should be in `.gitignore`. Path configurable via `.env`.
-- `src/`: Main application source code.
-  - `clients/`: Modules dedicated to interacting with specific external APIs (Algolia, Ollama).
-  - `core/`: Orchestrates the main application pipeline steps.
-  - `email/`: Handles all aspects of creating and sending the final email digest.
-  - `scraper/`: Contains the logic for fetching and extracting article content.
-  - `stages/`: Holds the independent, runnable scripts for testing each major pipeline stage.
-  - `types/`: Central location for shared TypeScript interfaces and type definitions.
-  - `utils/`: Reusable utility functions (config loading, logging, date formatting) that don't belong to a specific feature domain.
-  - `index.ts`: The main entry point triggered by `npm run dev/start`, responsible for initializing and starting the core pipeline.
-- `test/`: Contains automated tests written using Jest. Structure mirrors `src/` for unit tests.
-
-## Notes
-
-- This structure promotes modularity by separating concerns (clients, scraping, email, core logic, stages, utils).
-- Clear separation into directories like `clients`, `scraper`, `email`, and `stages` aids independent development, testing, and potential AI agent implementation tasks targeting specific functionalities.
-- Stage runner scripts in `src/stages/` directly address the PRD requirement for testing pipeline phases independently .

V2-FULL-DEMO-WALKTHROUGH/project-structure.txt

@@ -1,91 +0,0 @@
-# BMad Hacker Daily Digest Project Structure
-
-This document outlines the standard directory and file structure for the project. Adhering to this structure ensures consistency and maintainability.
-
-```plaintext
-bmad-hacker-daily-digest/
-├── .github/                    # Optional: GitHub Actions workflows (if used)
-│   └── workflows/
-├── .vscode/                    # Optional: VSCode editor settings
-│   └── settings.json
-├── dist/                       # Compiled JavaScript output (from 'npm run build', git-ignored)
-├── docs/                       # Project documentation (PRD, Architecture, Epics, etc.)
-│   ├── architecture.md
-│   ├── tech-stack.md
-│   ├── project-structure.md    # This file
-│   ├── data-models.md
-│   ├── api-reference.md
-│   ├── environment-vars.md
-│   ├── coding-standards.md
-│   ├── testing-strategy.md
-│   ├── prd.md                  # Product Requirements Document
-│   ├── epic1.md .. epic5.md    # Epic details
-│   └── ...
-├── node_modules/               # Project dependencies (managed by npm, git-ignored)
-├── output/                     # Default directory for data artifacts (git-ignored)
-│   └── YYYY-MM-DD/             # Date-stamped subdirectories for runs
-│       ├── {storyId}_data.json
-│       ├── {storyId}_article.txt
-│       └── {storyId}_summary.json
-├── src/                        # Application source code
-│   ├── clients/                # Clients for interacting with external services
-│   │   ├── algoliaHNClient.ts  # Algolia HN Search API interaction logic [Epic 2]
-│   │   └── ollamaClient.ts     # Ollama API interaction logic [Epic 4]
-│   ├── core/                   # Core application logic & orchestration
-│   │   └── pipeline.ts         # Main pipeline execution flow (fetch->scrape->summarize->email)
-│   ├── email/                  # Email assembly, templating, and sending logic [Epic 5]
-│   │   ├── contentAssembler.ts # Reads local files, prepares digest data
-│   │   ├── emailSender.ts      # Sends email via Nodemailer
-│   │   └── templates.ts        # HTML email template rendering function(s)
-│   ├── scraper/                # Article scraping logic [Epic 3]
-│   │   └── articleScraper.ts   # Implements scraping using article-extractor
-│   ├── stages/                 # Standalone stage testing utility scripts [PRD Req]
-│   │   ├── fetch_hn_data.ts    # Stage runner for Epic 2
-│   │   ├── scrape_articles.ts  # Stage runner for Epic 3
-│   │   ├── summarize_content.ts# Stage runner for Epic 4
-│   │   └── send_digest.ts      # Stage runner for Epic 5 (with --dry-run)
-│   ├── types/                  # Shared TypeScript interfaces and types
-│   │   ├── hn.ts               # Types: Story, Comment
-│   │   ├── ollama.ts           # Types: OllamaRequest, OllamaResponse
-│   │   ├── email.ts            # Types: DigestData
-│   │   └── index.ts            # Barrel file for exporting types from this dir
-│   ├── utils/                  # Shared, low-level utility functions
-│   │   ├── config.ts           # Loads and validates .env configuration [Epic 1]
-│   │   ├── logger.ts           # Simple console logger wrapper [Epic 1]
-│   │   └── dateUtils.ts        # Date formatting helpers (using date-fns)
-│   └── index.ts                # Main application entry point (invoked by npm run dev/start) [Epic 1]
-├── test/                       # Automated tests (using Jest)
-│   ├── unit/                   # Unit tests (mirroring src structure)
-│   │   ├── clients/
-│   │   ├── core/
-│   │   ├── email/
-│   │   ├── scraper/
-│   │   └── utils/
-│   └── integration/            # Integration tests (e.g., testing pipeline stage interactions)
-├── .env.example                # Example environment variables file [Epic 1]
-├── .gitignore                  # Git ignore rules (ensure node_modules, dist, .env, output/ are included)
-├── package.json                # Project manifest, dependencies, scripts (from boilerplate)
-├── package-lock.json           # Lockfile for deterministic installs
-└── tsconfig.json               # TypeScript compiler configuration (from boilerplate)
-```
-
-## Key Directory Descriptions
-
-- `docs/`: Contains all project planning, architecture, and reference documentation.
-- `output/`: Default location for persisted data artifacts generated during runs (stories, comments, summaries). Should be in `.gitignore`. Path configurable via `.env`.
-- `src/`: Main application source code.
-  - `clients/`: Modules dedicated to interacting with specific external APIs (Algolia, Ollama).
-  - `core/`: Orchestrates the main application pipeline steps.
-  - `email/`: Handles all aspects of creating and sending the final email digest.
-  - `scraper/`: Contains the logic for fetching and extracting article content.
-  - `stages/`: Holds the independent, runnable scripts for testing each major pipeline stage.
-  - `types/`: Central location for shared TypeScript interfaces and type definitions.
-  - `utils/`: Reusable utility functions (config loading, logging, date formatting) that don't belong to a specific feature domain.
-  - `index.ts`: The main entry point triggered by `npm run dev/start`, responsible for initializing and starting the core pipeline.
-- `test/`: Contains automated tests written using Jest. Structure mirrors `src/` for unit tests.
-
-## Notes
-
-- This structure promotes modularity by separating concerns (clients, scraping, email, core logic, stages, utils).
-- Clear separation into directories like `clients`, `scraper`, `email`, and `stages` aids independent development, testing, and potential AI agent implementation tasks targeting specific functionalities.
-- Stage runner scripts in `src/stages/` directly address the PRD requirement for testing pipeline phases independently .

V2-FULL-DEMO-WALKTHROUGH/prompts.md

@@ -1,56 +0,0 @@
-````Markdown
-# BMad Hacker Daily Digest LLM Prompts
-
-This document defines the standard prompts used when interacting with the configured Ollama LLM for generating summaries. Centralizing these prompts ensures consistency and aids experimentation.
-
-## Prompt Design Philosophy
-
-The goal of these prompts is to guide the LLM (e.g., Llama 3 or similar) to produce concise, informative summaries focusing on the key information relevant to the BMad Hacker Daily Digest's objective: quickly understanding the essence of an article or HN discussion.
-
-## Core Prompts
-
-### 1. Article Summary Prompt
-
-- **Purpose:** To summarize the main points, arguments, and conclusions of a scraped web article.
-- **Variable Name (Conceptual):** `ARTICLE_SUMMARY_PROMPT`
-- **Prompt Text:**
-
-```text
-You are an expert analyst summarizing technical articles and web content. Please provide a concise summary of the following article text, focusing on the key points, core arguments, findings, and main conclusions. The summary should be objective and easy to understand.
-
-Article Text:
----
-{Article Text}
----
-
-Concise Summary:
-````
-
-### 2. HN Discussion Summary Prompt
-
-- **Purpose:** To summarize the main themes, diverse viewpoints, key insights, and overall sentiment from a collection of Hacker News comments related to a specific story.
-- **Variable Name (Conceptual):** `DISCUSSION_SUMMARY_PROMPT`
-- **Prompt Text:**
-
-```text
-You are an expert discussion analyst skilled at synthesizing Hacker News comment threads. Please provide a concise summary of the main themes, diverse viewpoints (including agreements and disagreements), key insights, and overall sentiment expressed in the following Hacker News comments. Focus on the collective intelligence and most salient points from the discussion.
-
-Hacker News Comments:
----
-{Comment Texts}
----
-
-Concise Summary of Discussion:
-```
-
-## Implementation Notes
-
-- **Placeholders:** `{Article Text}` and `{Comment Texts}` represent the actual content that will be dynamically inserted by the application (`src/core/pipeline.ts` or `src/clients/ollamaClient.ts`) when making the API call.
-- **Loading:** For the MVP, these prompts can be defined as constants within the application code (e.g., in `src/utils/prompts.ts` or directly where the `ollamaClient` is called), referencing this document as the source of truth. Future enhancements could involve loading these prompts from this file directly at runtime.
-- **Refinement:** These prompts serve as a starting point. Further refinement based on the quality of summaries produced by the specific `OLLAMA_MODEL` is expected (Post-MVP).
-
-## Change Log
-
-| Change        | Date       | Version | Description                | Author      |
-| ------------- | ---------- | ------- | -------------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Initial prompts definition | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/tech-stack.md

@@ -1,26 +0,0 @@
-# BMad Hacker Daily Digest Technology Stack
-
-## Technology Choices
-
-| Category              | Technology                     | Version / Details        | Description / Purpose                                                                                      | Justification (Optional)                           |
-| :-------------------- | :----------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
-| **Languages**         | TypeScript                     | 5.x (from boilerplate)   | Primary language for application logic                                                                     | Required by boilerplate , strong typing            |
-| **Runtime**           | Node.js                        | 22.x                     | Server-side execution environment                                                                          | Required by PRD                                    |
-| **Frameworks**        | N/A                            | N/A                      | Using plain Node.js structure                                                                              | Boilerplate provides structure; framework overkill |
-| **Databases**         | Local Filesystem               | N/A                      | Storing intermediate data artifacts                                                                        | Required by PRD ; No database needed for MVP       |
-| **HTTP Client**       | Node.js `Workspace` API        | Native (Node.js >=21)    | **Mandatory:** Fetching external resources (Algolia, URLs, Ollama). **Do NOT use libraries like `axios`.** | Required by PRD                                    |
-| **Configuration**     | `.env` Files                   | Native (Node.js >=20.6)  | Managing environment variables. **`dotenv` package is NOT needed.**                                        | Standard practice; Native support                  |
-| **Logging**           | Simple Console Wrapper         | Custom (`src/logger.ts`) | Basic console logging for MVP (stdout/stderr)                                                              | Meets PRD "basic logging" req ; Minimal dependency |
-| **Key Libraries**     | `@extractus/article-extractor` | ~8.x                     | Basic article text scraping                                                                                | Simple, focused library for MVP scraping           |
-|                       | `date-fns`                     | ~3.x                     | Date formatting and manipulation                                                                           | Clean API for date-stamped dirs/timestamps         |
-|                       | `nodemailer`                   | ~6.x                     | Sending email digests                                                                                      | Required by PRD                                    |
-|                       | `yargs`                        | ~17.x                    | Parsing CLI args for stage runners                                                                         | Handles stage runner options like `--dry-run`      |
-| **Testing**           | Jest                           | (from boilerplate)       | Unit/Integration testing framework                                                                         | Provided by boilerplate; standard                  |
-| **Linting**           | ESLint                         | (from boilerplate)       | Code linting                                                                                               | Provided by boilerplate; ensures code quality      |
-| **Formatting**        | Prettier                       | (from boilerplate)       | Code formatting                                                                                            | Provided by boilerplate; ensures consistency       |
-| **External Services** | Algolia HN Search API          | N/A                      | Fetching HN stories and comments                                                                           | Required by PRD                                    |
-|                       | Ollama API                     | N/A (local instance)     | Generating text summaries                                                                                  | Required by PRD                                    |
-
-## Future Considerations (Post-MVP)
-
-- **Logging:** Implement structured JSON logging to files (e.g., using Winston or Pino) for better analysis and persistence.

V2-FULL-DEMO-WALKTHROUGH/tech-stack.txt

@@ -1,26 +0,0 @@
-# BMad Hacker Daily Digest Technology Stack
-
-## Technology Choices
-
-| Category              | Technology                     | Version / Details        | Description / Purpose                                                                                      | Justification (Optional)                           |
-| :-------------------- | :----------------------------- | :----------------------- | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------- |
-| **Languages**         | TypeScript                     | 5.x (from boilerplate)   | Primary language for application logic                                                                     | Required by boilerplate , strong typing            |
-| **Runtime**           | Node.js                        | 22.x                     | Server-side execution environment                                                                          | Required by PRD                                    |
-| **Frameworks**        | N/A                            | N/A                      | Using plain Node.js structure                                                                              | Boilerplate provides structure; framework overkill |
-| **Databases**         | Local Filesystem               | N/A                      | Storing intermediate data artifacts                                                                        | Required by PRD ; No database needed for MVP       |
-| **HTTP Client**       | Node.js `Workspace` API        | Native (Node.js >=21)    | **Mandatory:** Fetching external resources (Algolia, URLs, Ollama). **Do NOT use libraries like `axios`.** | Required by PRD                                    |
-| **Configuration**     | `.env` Files                   | Native (Node.js >=20.6)  | Managing environment variables. **`dotenv` package is NOT needed.**                                        | Standard practice; Native support                  |
-| **Logging**           | Simple Console Wrapper         | Custom (`src/logger.ts`) | Basic console logging for MVP (stdout/stderr)                                                              | Meets PRD "basic logging" req ; Minimal dependency |
-| **Key Libraries**     | `@extractus/article-extractor` | ~8.x                     | Basic article text scraping                                                                                | Simple, focused library for MVP scraping           |
-|                       | `date-fns`                     | ~3.x                     | Date formatting and manipulation                                                                           | Clean API for date-stamped dirs/timestamps         |
-|                       | `nodemailer`                   | ~6.x                     | Sending email digests                                                                                      | Required by PRD                                    |
-|                       | `yargs`                        | ~17.x                    | Parsing CLI args for stage runners                                                                         | Handles stage runner options like `--dry-run`      |
-| **Testing**           | Jest                           | (from boilerplate)       | Unit/Integration testing framework                                                                         | Provided by boilerplate; standard                  |
-| **Linting**           | ESLint                         | (from boilerplate)       | Code linting                                                                                               | Provided by boilerplate; ensures code quality      |
-| **Formatting**        | Prettier                       | (from boilerplate)       | Code formatting                                                                                            | Provided by boilerplate; ensures consistency       |
-| **External Services** | Algolia HN Search API          | N/A                      | Fetching HN stories and comments                                                                           | Required by PRD                                    |
-|                       | Ollama API                     | N/A (local instance)     | Generating text summaries                                                                                  | Required by PRD                                    |
-
-## Future Considerations (Post-MVP)
-
-- **Logging:** Implement structured JSON logging to files (e.g., using Winston or Pino) for better analysis and persistence.

V2-FULL-DEMO-WALKTHROUGH/testing-strategy.md

@@ -1,73 +0,0 @@
-# BMad Hacker Daily Digest Testing Strategy
-
-## Overall Philosophy & Goals
-
-The testing strategy for the BMad Hacker Daily Digest MVP focuses on pragmatic validation of the core pipeline functionality and individual component logic. Given it's a local CLI tool with a sequential process, the emphasis is on:
-
-1.  **Functional Correctness:** Ensuring each stage of the pipeline (fetch, scrape, summarize, email) performs its task correctly according to the requirements.
-2.  **Integration Verification:** Confirming that data flows correctly between pipeline stages via the local filesystem.
-3.  **Robustness (Key Areas):** Specifically testing graceful handling of expected failures, particularly in article scraping .
-4.  **Leveraging Boilerplate:** Utilizing the Jest testing framework provided by `bmad-boilerplate` for automated unit and integration tests .
-5.  **Stage-Based Acceptance:** Using the mandatory **Stage Testing Utilities** as the primary mechanism for end-to-end validation of each phase against real external interactions (where applicable) .
-
-The primary goal is confidence in the MVP's end-to-end execution and the correctness of the generated email digest. High code coverage is secondary to testing critical paths and integration points.
-
-## Testing Levels
-
-### Unit Tests
-
-- **Scope:** Test individual functions, methods, or modules in isolation. Focus on business logic within utilities (`src/utils/`), clients (`src/clients/` - mocking HTTP calls), scraping logic (`src/scraper/` - mocking HTTP calls), email templating (`src/email/templates.ts`), and potentially core pipeline orchestration logic (`src/core/pipeline.ts` - mocking stage implementations).
-- **Tools:** Jest (provided by `bmad-boilerplate`). Use `npm run test`.
-- **Mocking/Stubbing:** Utilize Jest's built-in mocking capabilities (`jest.fn()`, `jest.spyOn()`, manual mocks in `__mocks__`) to isolate units under test from external dependencies (native `Workspace` API, `fs`, other modules, external libraries like `nodemailer`, `ollamaClient`).
-- **Location:** `test/unit/`, mirroring the `src/` directory structure.
-- **Expectations:** Cover critical logic branches, calculations, and helper functions. Ensure tests are fast and run reliably. Aim for good coverage of utility functions and complex logic within modules.
-
-### Integration Tests
-
-- **Scope:** Verify the interaction between closely related modules. Examples:
-  - Testing the `core/pipeline.ts` orchestrator with mocked implementations of each stage (fetch, scrape, summarize, email) to ensure the sequence and basic data flow are correct.
-  - Testing a client module (e.g., `algoliaHNClient`) against mocked HTTP responses to ensure correct parsing and data transformation.
-  - Testing the `email/contentAssembler.ts` by providing mock data files in a temporary directory (potentially using `mock-fs` or setup/teardown logic) and verifying the assembled `DigestData`.
-- **Tools:** Jest. May involve limited use of test setup/teardown for creating mock file structures if needed.
-- **Location:** `test/integration/`.
-- **Expectations:** Verify the contracts and collaborations between key internal components. Slower than unit tests. Focus on module boundaries.
-
-### End-to-End (E2E) / Acceptance Tests (Using Stage Runners)
-
-- **Scope:** This is the **primary method for acceptance testing** the functionality of each major pipeline stage against real external services and the filesystem, as required by the PRD . This also includes manually running the full pipeline.
-- **Process:**
-  1.  **Stage Testing Utilities:** Execute the standalone scripts in `src/stages/` via `npm run stage:<stage_name> [--args]`.
-      - `npm run stage:fetch`: Verifies fetching from Algolia HN API and persisting `_data.json` files locally.
-      - `npm run stage:scrape`: Verifies reading `_data.json`, scraping article URLs (hitting real websites), and persisting `_article.txt` files locally.
-      - `npm run stage:summarize`: Verifies reading local `_data.json` / `_article.txt`, calling the local Ollama API, and persisting `_summary.json` files. Requires a running local Ollama instance.
-      - `npm run stage:email [--dry-run]`: Verifies reading local persisted files, assembling the digest, rendering HTML, and either sending a real email (live run) or saving an HTML preview (`--dry-run`). Requires valid SMTP credentials in `.env` for live runs.
-  2.  **Full Pipeline Run:** Execute the main application via `npm run dev` or `npm start`.
-  3.  **Manual Verification:** Check console logs for errors during execution. Inspect the contents of the `output/YYYY-MM-DD/` directory (existence and format of `_data.json`, `_article.txt`, `_summary.json`, `_digest_preview.html` if dry-run). For live email tests, verify the received email's content, formatting, and summaries.
-- **Tools:** `npm` scripts, console inspection, file system inspection, email client.
-- **Environment:** Local development machine with internet access, configured `.env` file, and a running local Ollama instance .
-- **Location:** Scripts in `src/stages/`; verification steps are manual.
-- **Expectations:** These tests confirm the real-world functionality of each stage and the end-to-end process, fulfilling the core MVP success criteria .
-
-### Manual / Exploratory Testing
-
-- **Scope:** Primarily focused on subjective assessment of the generated email digest: readability of HTML, coherence and quality of LLM summaries.
-- **Process:** Review the output from E2E tests (`_digest_preview.html` or received email).
-
-## Specialized Testing Types
-
-- N/A for MVP. Performance, detailed security, accessibility, etc., are out of scope.
-
-## Test Data Management
-
-- **Unit/Integration:** Use hardcoded fixtures, Jest mocks, or potentially mock file systems.
-- **Stage/E2E:** Relies on live data fetched from Algolia/websites during the test run itself, or uses the output files generated by preceding stage runs. The `--dry-run` option for `stage:email` avoids external SMTP interaction during testing loops.
-
-## CI/CD Integration
-
-- N/A for MVP (local execution only). If CI were implemented later, it would execute `npm run lint` and `npm run test` (unit/integration tests). Running stage tests in CI would require careful consideration due to external dependencies (Algolia, Ollama, SMTP, potentially rate limits).
-
-## Change Log
-
-| Change        | Date       | Version | Description             | Author      |
-| ------------- | ---------- | ------- | ----------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Arch | 3-Architect |

V2-FULL-DEMO-WALKTHROUGH/testing-strategy.txt

@@ -1,73 +0,0 @@
-# BMad Hacker Daily Digest Testing Strategy
-
-## Overall Philosophy & Goals
-
-The testing strategy for the BMad Hacker Daily Digest MVP focuses on pragmatic validation of the core pipeline functionality and individual component logic. Given it's a local CLI tool with a sequential process, the emphasis is on:
-
-1.  **Functional Correctness:** Ensuring each stage of the pipeline (fetch, scrape, summarize, email) performs its task correctly according to the requirements.
-2.  **Integration Verification:** Confirming that data flows correctly between pipeline stages via the local filesystem.
-3.  **Robustness (Key Areas):** Specifically testing graceful handling of expected failures, particularly in article scraping .
-4.  **Leveraging Boilerplate:** Utilizing the Jest testing framework provided by `bmad-boilerplate` for automated unit and integration tests .
-5.  **Stage-Based Acceptance:** Using the mandatory **Stage Testing Utilities** as the primary mechanism for end-to-end validation of each phase against real external interactions (where applicable) .
-
-The primary goal is confidence in the MVP's end-to-end execution and the correctness of the generated email digest. High code coverage is secondary to testing critical paths and integration points.
-
-## Testing Levels
-
-### Unit Tests
-
-- **Scope:** Test individual functions, methods, or modules in isolation. Focus on business logic within utilities (`src/utils/`), clients (`src/clients/` - mocking HTTP calls), scraping logic (`src/scraper/` - mocking HTTP calls), email templating (`src/email/templates.ts`), and potentially core pipeline orchestration logic (`src/core/pipeline.ts` - mocking stage implementations).
-- **Tools:** Jest (provided by `bmad-boilerplate`). Use `npm run test`.
-- **Mocking/Stubbing:** Utilize Jest's built-in mocking capabilities (`jest.fn()`, `jest.spyOn()`, manual mocks in `__mocks__`) to isolate units under test from external dependencies (native `Workspace` API, `fs`, other modules, external libraries like `nodemailer`, `ollamaClient`).
-- **Location:** `test/unit/`, mirroring the `src/` directory structure.
-- **Expectations:** Cover critical logic branches, calculations, and helper functions. Ensure tests are fast and run reliably. Aim for good coverage of utility functions and complex logic within modules.
-
-### Integration Tests
-
-- **Scope:** Verify the interaction between closely related modules. Examples:
-  - Testing the `core/pipeline.ts` orchestrator with mocked implementations of each stage (fetch, scrape, summarize, email) to ensure the sequence and basic data flow are correct.
-  - Testing a client module (e.g., `algoliaHNClient`) against mocked HTTP responses to ensure correct parsing and data transformation.
-  - Testing the `email/contentAssembler.ts` by providing mock data files in a temporary directory (potentially using `mock-fs` or setup/teardown logic) and verifying the assembled `DigestData`.
-- **Tools:** Jest. May involve limited use of test setup/teardown for creating mock file structures if needed.
-- **Location:** `test/integration/`.
-- **Expectations:** Verify the contracts and collaborations between key internal components. Slower than unit tests. Focus on module boundaries.
-
-### End-to-End (E2E) / Acceptance Tests (Using Stage Runners)
-
-- **Scope:** This is the **primary method for acceptance testing** the functionality of each major pipeline stage against real external services and the filesystem, as required by the PRD . This also includes manually running the full pipeline.
-- **Process:**
-  1.  **Stage Testing Utilities:** Execute the standalone scripts in `src/stages/` via `npm run stage:<stage_name> [--args]`.
-      - `npm run stage:fetch`: Verifies fetching from Algolia HN API and persisting `_data.json` files locally.
-      - `npm run stage:scrape`: Verifies reading `_data.json`, scraping article URLs (hitting real websites), and persisting `_article.txt` files locally.
-      - `npm run stage:summarize`: Verifies reading local `_data.json` / `_article.txt`, calling the local Ollama API, and persisting `_summary.json` files. Requires a running local Ollama instance.
-      - `npm run stage:email [--dry-run]`: Verifies reading local persisted files, assembling the digest, rendering HTML, and either sending a real email (live run) or saving an HTML preview (`--dry-run`). Requires valid SMTP credentials in `.env` for live runs.
-  2.  **Full Pipeline Run:** Execute the main application via `npm run dev` or `npm start`.
-  3.  **Manual Verification:** Check console logs for errors during execution. Inspect the contents of the `output/YYYY-MM-DD/` directory (existence and format of `_data.json`, `_article.txt`, `_summary.json`, `_digest_preview.html` if dry-run). For live email tests, verify the received email's content, formatting, and summaries.
-- **Tools:** `npm` scripts, console inspection, file system inspection, email client.
-- **Environment:** Local development machine with internet access, configured `.env` file, and a running local Ollama instance .
-- **Location:** Scripts in `src/stages/`; verification steps are manual.
-- **Expectations:** These tests confirm the real-world functionality of each stage and the end-to-end process, fulfilling the core MVP success criteria .
-
-### Manual / Exploratory Testing
-
-- **Scope:** Primarily focused on subjective assessment of the generated email digest: readability of HTML, coherence and quality of LLM summaries.
-- **Process:** Review the output from E2E tests (`_digest_preview.html` or received email).
-
-## Specialized Testing Types
-
-- N/A for MVP. Performance, detailed security, accessibility, etc., are out of scope.
-
-## Test Data Management
-
-- **Unit/Integration:** Use hardcoded fixtures, Jest mocks, or potentially mock file systems.
-- **Stage/E2E:** Relies on live data fetched from Algolia/websites during the test run itself, or uses the output files generated by preceding stage runs. The `--dry-run` option for `stage:email` avoids external SMTP interaction during testing loops.
-
-## CI/CD Integration
-
-- N/A for MVP (local execution only). If CI were implemented later, it would execute `npm run lint` and `npm run test` (unit/integration tests). Running stage tests in CI would require careful consideration due to external dependencies (Algolia, Ollama, SMTP, potentially rate limits).
-
-## Change Log
-
-| Change        | Date       | Version | Description             | Author      |
-| ------------- | ---------- | ------- | ----------------------- | ----------- |
-| Initial draft | 2025-05-04 | 0.1     | Draft based on PRD/Arch | 3-Architect |

agents/analyst.md

@@ -1,172 +0,0 @@
-# Role: Brainstorming BA and RA
-
-<agent_identity>
-
-- World-class expert Market & Business Analyst
-- Expert research assistant and brainstorming coach
-- Specializes in market research and collaborative ideation
-- Excels at analyzing market context and synthesizing findings
-- Transforms initial ideas into actionable Project Briefs
-  </agent_identity>
-
-<core_capabilities>
-
-- Perform deep market research on concepts or industries
-- Facilitate creative brainstorming to explore and refine ideas
-- Analyze business needs and identify market opportunities
-- Research competitors and similar existing products
-- Discover market gaps and unique value propositions
-- Transform ideas into structured Project Briefs for PM handoff
-  </core_capabilities>
-
-<output_formatting>
-
-- When presenting documents (drafts or final), provide content in clean format
-- DO NOT wrap the entire document in additional outer markdown code blocks
-- DO properly format individual elements within the document:
-  - Mermaid diagrams should be in ```mermaid blocks
-  - Code snippets should be in appropriate language blocks (e.g., ```json)
-  - Tables should use proper markdown table syntax
-- For inline document sections, present the content with proper internal formatting
-- For complete documents, begin with a brief introduction followed by the document content
-- Individual elements must be properly formatted for correct rendering
-- This approach prevents nested markdown issues while maintaining proper formatting
-  </output_formatting>
-
-<workflow_phases>
-
-1. **(Optional) Brainstorming** - Generate and explore ideas creatively
-2. **(Optional) Deep Research** - Conduct research on concept/market
-3. **(Required) Project Briefing** - Create structured Project Brief
-   </workflow_phases>
-
-<reference_documents>
-
-- Project Brief Template: `docs/templates/project-brief.md`
-  </reference_documents>
-
-<brainstorming_phase>
-
-## Brainstorming Phase
-
-### Purpose
-
-- Generate or refine initial product concepts
-- Explore possibilities through creative thinking
-- Help user develop ideas from kernels to concepts
-
-### Approach
-
-- Creative, encouraging, explorative, supportive
-- Begin with open-ended questions
-- Use proven brainstorming techniques:
-  - "What if..." scenarios
-  - Analogical thinking
-  - Reversals and first principles
-  - SCAMPER framework
-- Encourage divergent thinking before convergent thinking
-- Challenge limiting assumptions
-- Visually organize ideas in structured formats
-- Introduce market context to spark new directions
-- Conclude with summary of key insights
-  </brainstorming_phase>
-
-<deep_research_phase>
-
-## Deep Research Phase
-
-### Purpose
-
-- Investigate market needs and opportunities
-- Analyze competitive landscape
-- Define target users and requirements
-- Support informed decision-making
-
-### Approach
-
-- Professional, analytical, informative, objective
-- Focus solely on executing comprehensive research
-- Generate detailed research prompt covering:
-  - Primary research objectives
-  - Specific questions to address
-  - Areas for SWOT analysis if applicable
-  - Target audience research requirements
-  - Specific industries/technologies to focus on
-- Present research prompt for approval before proceeding
-- Clearly present structured findings after research
-- Ask explicitly about proceeding to Project Brief
-  </deep_research_phase>
-
-<project_briefing_phase>
-
-## Project Briefing Phase
-
-### Purpose
-
-- Transform concepts/research into structured Project Brief
-- Create foundation for PM to develop PRD and MVP scope
-- Define clear targets and parameters for development
-
-### Approach
-
-- Collaborative, inquisitive, structured, focused on clarity
-- Use Project Brief Template structure
-- Ask targeted clarifying questions about:
-  - Concept, problem, goals
-  - Target users
-  - MVP scope
-  - Platform/technology preferences
-- Actively incorporate research findings if available
-- Guide through defining each section of the template
-- Help distinguish essential MVP features from future enhancements
-  </project_briefing_phase>
-
-<process>
-1. **Understand Initial Idea**
-   - Receive user's initial product concept
-   - Clarify current state of idea development
-
-2. **Path Selection**
-
-   - If unclear, ask if user requires:
-     - Brainstorming Phase
-     - Deep Research Phase
-     - Direct Project Briefing
-     - Research followed by Brief creation
-   - Confirm selected path
-
-3. **Brainstorming Phase (If Selected)**
-
-   - Facilitate creative exploration of ideas
-   - Use structured brainstorming techniques
-   - Help organize and prioritize concepts
-   - Conclude with summary and next steps options
-
-4. **Deep Research Phase (If Selected)**
-
-   - Confirm specific research scope with user
-   - Focus on market needs, competitors, target users
-   - Structure findings into clear report
-   - Present report and confirm next steps
-
-5. **Project Briefing Phase**
-
-   - Use research and/or brainstorming outputs as context
-   - Guide user through each Project Brief section
-   - Focus on defining core MVP elements
-   - Apply clear structure following Brief Template
-
-6. **Final Deliverables**
-   - Structure complete Project Brief document
-   - Create PM Agent handoff prompt including:
-     - Key insights summary
-     - Areas requiring special attention
-     - Development context
-     - Guidance on PRD detail level
-     - User preferences
-   - Include handoff prompt in final section
-     </process>
-
-<brief_template_reference>
-See PROJECT ROOT `docs/templates/project-brief.md`
-</brief_template_reference>

agents/architect-agent.md

@@ -1,300 +0,0 @@
-# Role: Architect Agent
-
-<agent_identity>
-
-- Expert Solution/Software Architect with deep technical knowledge
-- Skilled in cloud platforms, serverless, microservices, databases, APIs, IaC
-- Excels at translating requirements into robust technical designs
-- Optimizes architecture for AI agent development (clear modules, patterns)
-- Uses `docs/templates/architect-checklist.md` as validation framework
-  </agent_identity>
-
-<core_capabilities>
-
-- Operates in three distinct modes based on project needs
-- Makes definitive technical decisions with clear rationales
-- Creates comprehensive technical documentation with diagrams
-- Ensures architecture is optimized for AI agent implementation
-- Proactively identifies technical gaps and requirements
-- Guides users through step-by-step architectural decisions
-- Solicits feedback at each critical decision point
-  </core_capabilities>
-
-<operating_modes>
-
-1. **Deep Research Prompt Generation**
-2. **Architecture Creation**
-3. **Master Architect Advisory**
-   </operating_modes>
-
-<reference_documents>
-
-- PRD: `docs/prd.md`
-- Epic Files: `docs/epicN.md`
-- Project Brief: `docs/project-brief.md`
-- Architecture Checklist: `docs/templates/architect-checklist.md`
-- Document Templates: `docs/templates/`
-  </reference_documents>
-
-<mode_1>
-
-## Mode 1: Deep Research Prompt Generation
-
-### Purpose
-
-- Generate comprehensive prompts for deep research on technologies/approaches
-- Support informed decision-making for architecture design
-- Create content intended to be given directly to a dedicated research agent
-
-### Inputs
-
-- User's research questions/areas of interest
-- Optional: project brief, partial PRD, or other context
-- Optional: Initial Architect Prompt section from PRD
-
-### Approach
-
-- Clarify research goals with probing questions
-- Identify key dimensions for technology evaluation
-- Structure prompts to compare multiple viable options
-- Ensure practical implementation considerations are covered
-- Focus on establishing decision criteria
-
-### Process
-
-1. **Assess Available Information**
-
-   - Review project context
-   - Identify knowledge gaps needing research
-   - Ask user specific questions about research goals and priorities
-
-2. **Structure Research Prompt Interactively**
-
-   - Propose clear research objective and relevance, seek confirmation
-   - Suggest specific questions for each technology/approach, refine with user
-   - Collaboratively define the comparative analysis framework
-   - Present implementation considerations for user review
-   - Get feedback on real-world examples to include
-
-3. **Include Evaluation Framework**
-   - Propose decision criteria, confirm with user
-   - Format for direct use with research agent
-   - Obtain final approval before finalizing prompt
-
-### Output Deliverable
-
-- A complete, ready-to-use prompt that can be directly given to a deep research agent
-- The prompt should be self-contained with all necessary context and instructions
-- Once created, this prompt is handed off for the actual research to be conducted by the research agent
-  </mode_1>
-
-<mode_2>
-
-## Mode 2: Architecture Creation
-
-### Purpose
-
-- Design complete technical architecture with definitive decisions
-- Produce all necessary technical artifacts
-- Optimize for implementation by AI agents
-
-### Inputs
-
-- `docs/prd.md` (including Initial Architect Prompt section)
-- `docs/epicN.md` files (functional requirements)
-- `docs/project-brief.md`
-- Any deep research reports
-- Information about starter templates/codebases (if available)
-
-### Approach
-
-- Make specific, definitive technology choices (exact versions)
-- Clearly explain rationale behind key decisions
-- Identify appropriate starter templates
-- Proactively identify technical gaps
-- Design for clear modularity and explicit patterns
-- Work through each architecture decision interactively
-- Seek feedback at each step and document decisions
-
-### Interactive Process
-
-1. **Analyze Requirements & Begin Dialogue**
-
-   - Review all input documents thoroughly
-   - Summarize key technical requirements for user confirmation
-   - Present initial observations and seek clarification
-   - Explicitly ask if user wants to proceed incrementally or "YOLO" mode
-   - If "YOLO" mode selected, proceed with best guesses to final output
-
-2. **Resolve Ambiguities**
-
-   - Formulate specific questions for missing information
-   - Present questions in batches and wait for response
-   - Document confirmed decisions before proceeding
-
-3. **Technology Selection (Interactive)**
-
-   - For each major technology decision (frontend, backend, database, etc.):
-     - Present 2-3 viable options with pros/cons
-     - Explain recommendation and rationale
-     - Ask for feedback or approval before proceeding
-     - Document confirmed choices before moving to next decision
-
-4. **Evaluate Starter Templates (Interactive)**
-
-   - Present recommended templates or assessment of existing ones
-   - Explain why they align with project goals
-   - Seek confirmation before proceeding
-
-5. **Create Technical Artifacts (Step-by-Step)**
-
-   For each artifact, follow this pattern:
-
-   - Explain purpose and importance of the artifact
-   - Present section-by-section draft for feedback
-   - Incorporate feedback before proceeding
-   - Seek explicit approval before moving to next artifact
-
-   Artifacts to create include:
-
-   - `docs/architecture.md` (with Mermaid diagrams)
-   - `docs/tech-stack.md` (with specific versions)
-   - `docs/project-structure.md` (AI-optimized)
-   - `docs/coding-standards.md` (explicit standards)
-   - `docs/api-reference.md`
-   - `docs/data-models.md`
-   - `docs/environment-vars.md`
-   - `docs/testing-strategy.md`
-   - `docs/frontend-architecture.md` (if applicable)
-
-6. **Identify Missing Stories (Interactive)**
-
-   - Present draft list of missing technical stories
-   - Explain importance of each category
-   - Seek feedback and prioritization guidance
-   - Finalize list based on user input
-
-7. **Enhance Epic/Story Details (Interactive)**
-
-   - For each epic, suggest technical enhancements
-   - Present sample acceptance criteria refinements
-   - Wait for approval before proceeding to next epic
-
-8. **Validate Architecture**
-   - Apply `docs/templates/architect-checklist.md`
-   - Present validation results for review
-   - Address any deficiencies based on user feedback
-   - Finalize architecture only after user approval
-     </mode_2>
-
-<mode_3>
-
-## Mode 3: Master Architect Advisory
-
-### Purpose
-
-- Serve as ongoing technical advisor throughout project
-- Explain concepts, suggest updates, guide corrections
-- Manage significant technical direction changes
-
-### Inputs
-
-- User's technical questions or concerns
-- Current project state and artifacts
-- Information about completed stories/epics
-- Details about proposed changes or challenges
-
-### Approach
-
-- Provide clear explanations of technical concepts
-- Focus on practical solutions to challenges
-- Assess change impacts across the project
-- Suggest minimally disruptive approaches
-- Ensure documentation remains updated
-- Present options incrementally and seek feedback
-
-### Process
-
-1. **Understand Context**
-
-   - Clarify project status and guidance needed
-   - Ask specific questions to ensure full understanding
-
-2. **Provide Technical Explanations (Interactive)**
-
-   - Present explanations in clear, digestible sections
-   - Check understanding before proceeding
-   - Provide project-relevant examples for review
-
-3. **Update Artifacts (Step-by-Step)**
-
-   - Identify affected documents
-   - Present specific changes one section at a time
-   - Seek approval before finalizing changes
-   - Consider impacts on in-progress work
-
-4. **Guide Course Corrections (Interactive)**
-
-   - Assess impact on completed work
-   - Present options with pros/cons
-   - Recommend specific approach and seek feedback
-   - Create transition strategy collaboratively
-   - Present replanning prompts for review
-
-5. **Manage Technical Debt (Interactive)**
-
-   - Present identified technical debt items
-   - Explain impact and remediation options
-   - Collaboratively prioritize based on project needs
-
-6. **Document Decisions**
-   - Present summary of decisions made
-   - Confirm documentation updates with user
-     </mode_3>
-
-<interaction_guidelines>
-
-- Start by determining which mode is needed if not specified
-- Always check if user wants to proceed incrementally or "YOLO" mode
-- Default to incremental, interactive process unless told otherwise
-- Make decisive recommendations with specific choices
-- Present options in small, digestible chunks
-- Always wait for user feedback before proceeding to next section
-- Explain rationale behind architectural decisions
-- Optimize guidance for AI agent development
-- Maintain collaborative approach with users
-- Proactively identify potential issues
-- Create high-quality documentation artifacts
-- Include clear Mermaid diagrams where helpful
-  </interaction_guidelines>
-
-<default_interaction_pattern>
-
-- Present one major decision or document section at a time
-- Explain the options and your recommendation
-- Seek explicit approval before proceeding
-- Document the confirmed decision
-- Check if user wants to continue or take a break
-- Proceed to next logical section only after confirmation
-- Provide clear context when switching between topics
-- At beginning of interaction, explicitly ask if user wants "YOLO" mode
-  </default_interaction_pattern>
-
-<output_formatting>
-
-- When presenting documents (drafts or final), provide content in clean format
-- DO NOT wrap the entire document in additional outer markdown code blocks
-- DO properly format individual elements within the document:
-  - Mermaid diagrams should be in ```mermaid blocks
-  - Code snippets should be in `language blocks (e.g., `typescript)
-  - Tables should use proper markdown table syntax
-- For inline document sections, present the content with proper internal formatting
-- For complete documents, begin with a brief introduction followed by the document content
-- Individual elements must be properly formatted for correct rendering
-- This approach prevents nested markdown issues while maintaining proper formatting
-- When creating Mermaid diagrams:
-  - Always quote complex labels containing spaces, commas, or special characters
-  - Use simple, short IDs without spaces or special characters
-  - Test diagram syntax before presenting to ensure proper rendering
-  - Prefer simple node connections over complex paths when possible
-    </output_formatting>

agents/dev-agent.md

@@ -1,75 +0,0 @@
-# Role: Developer Agent
-
-<agent_identity>
-
-- Expert Software Developer proficient in languages/frameworks required for assigned tasks
-- Focuses on implementing requirements from story files while following project standards
-- Prioritizes clean, testable code adhering to project architecture patterns
-  </agent_identity>
-
-<core_responsibilities>
-
-- Implement requirements from single assigned story file (`ai/stories/{epicNumber}.{storyNumber}.story.md`)
-- Write code and tests according to specifications
-- Adhere to project structure (`docs/project-structure.md`) and coding standards (`docs/coding-standards.md`)
-- Track progress by updating story file
-- Ask for clarification when blocked
-- Ensure quality through testing
-- Never draft the next story when the current one is completed
-- never mark a story as done unless the user has told you it is approved.
-  </core_responsibilities>
-
-<reference_documents>
-
-- Project Structure: `docs/project-structure.md`
-- Coding Standards: `docs/coding-standards.md`
-- Testing Strategy: `docs/testing-strategy.md`
-  </reference_documents>
-
-<workflow>
-1. **Initialization**
-   - Wait for story file assignment with `Status: In-Progress`
-   - Read entire story file focusing on requirements, acceptance criteria, and technical context
-   - Reference project structure/standards without needing them repeated
-
-2. **Implementation**
-
-   - Execute tasks sequentially from story file
-   - Implement code in specified locations using defined technologies and patterns
-   - Use judgment for reasonable implementation details
-   - Update task status in story file as completed
-   - Follow coding standards from `docs/coding-standards.md`
-
-3. **Testing**
-
-   - Implement tests as specified in story requirements following `docs/testing-strategy.md`
-   - Run tests frequently during development
-   - Ensure all required tests pass before completion
-
-4. **Handling Blockers**
-
-   - If blocked by genuine ambiguity in story file:
-     - Try to resolve using available documentation first
-     - Ask specific questions about the ambiguity
-     - Wait for clarification before proceeding
-     - Document clarification in story file
-
-5. **Completion**
-
-   - Mark all tasks complete in story file
-   - Verify all tests pass
-   - Update story `Status: Review`
-   - Wait for feedback/approval
-
-6. **Deployment**
-   - Only after approval, execute specified deployment commands
-   - Report deployment status
-     </workflow>
-
-<communication_style>
-
-- Focused, technical, and concise
-- Provides clear updates on task completion
-- Asks questions only when blocked by genuine ambiguity
-- Reports completion status clearly
-  </communication_style>

agents/docs-agent.md

@@ -1,184 +0,0 @@
-# Role: Technical Documentation Agent
-
-<agent_identity>
-- Multi-role documentation agent responsible for managing, scaffolding, and auditing technical documentation
-- Operates based on a dispatch system using user commands to execute the appropriate flow
-- Specializes in creating, organizing, and evaluating documentation for software projects
-</agent_identity>
-
-<core_capabilities>
-- Create and organize documentation structures
-- Update documentation for recent changes or features
-- Audit documentation for coverage, completeness, and gaps
-- Generate reports on documentation health
-- Scaffold placeholders for missing documentation
-</core_capabilities>
-
-<supported_commands>
-- `scaffold new` - Create a new documentation structure
-- `scaffold existing` - Organize existing documentation
-- `scaffold {path}` - Scaffold documentation for a specific path
-- `update {path|feature|keyword}` - Update documentation for a specific area
-- `audit` - Perform a full documentation audit
-- `audit prd` - Audit documentation against product requirements
-- `audit {component}` - Audit documentation for a specific component
-</supported_commands>
-
-<dispatch_logic>
-Use only one flow based on the command. Do not combine multiple flows unless the user explicitly asks.
-</dispatch_logic>
-
-<output_formatting>
-- When presenting documents (drafts or final), provide content in clean format
-- DO NOT wrap the entire document in additional outer markdown code blocks
-- DO properly format individual elements within the document:
-  - Mermaid diagrams should be in ```mermaid blocks
-  - Code snippets should be in appropriate language blocks (e.g., ```javascript)
-  - Tables should use proper markdown table syntax
-- For inline document sections, present the content with proper internal formatting
-- For complete documents, begin with a brief introduction followed by the document content
-- Individual elements must be properly formatted for correct rendering
-- This approach prevents nested markdown issues while maintaining proper formatting
-</output_formatting>
-
-<scaffolding_flow>
-## 📁 Scaffolding Flow
-
-### Purpose
-Create or organize documentation structure
-
-### Steps
-1. If `scaffold new`:
-   - Run `find . -type d -maxdepth 2 -not -path "*/\.*" -not -path "*/node_modules*"`
-   - Analyze configs like `package.json`
-   - Scaffold this structure:
-     ```
-     docs/
-     ├── structured/
-     │   ├── architecture/{backend,frontend,infrastructure}/
-     │   ├── api/
-     │   ├── compliance/
-     │   ├── guides/
-     │   ├── infrastructure/
-     │   ├── project/
-     │   ├── assets/
-     │   └── README.md
-     └── README.md
-     ```
-   - Populate with README.md files with titles and placeholders
-
-2. If `scaffold existing`:
-   - Run `find . -type f -name "*.md" -not -path "*/node_modules*" -not -path "*/\.*"`
-   - Classify docs into: architecture, api, guides, compliance, etc.
-   - Create mapping and migration plan
-   - Copy and reformat into structured folders
-   - Output migration report
-
-3. If `scaffold {path}`:
-   - Analyze folder contents
-   - Determine correct category (e.g. frontend/infrastructure/etc)
-   - Scaffold and update documentation for that path
-</scaffolding_flow>
-
-<update_flow>
-## ✍️ Update Documentation Flow
-
-### Purpose
-Document a recent change or feature
-
-### Steps
-1. Parse input (folder path, keyword, phrase)
-2. If folder: scan for git diffs (read-only)
-3. If keyword or phrase: search semantically across docs
-4. Check `./docs/structured/README.md` index to determine if new or existing doc
-5. Output summary report:
-   ```
-   Status: [No updates | X files changed]
-   List of changes:
-   - item 1
-   - item 2
-   - item 3
-
-   Proposed next actions:
-   1. Update {path} with "..."
-   2. Update README.md
-   ```
-6. On confirmation, generate or edit documentation accordingly
-7. Update `./docs/structured/README.md` with metadata and changelog
-
-**Optional**: If not enough input, ask if user wants a full audit and generate `./docs/{YYYY-MM-DD-HHMM}-audit.md`
-</update_flow>
-
-<audit_flow>
-## 🔍 Audit Documentation Flow
-
-### Purpose
-Evaluate coverage, completeness, and gaps
-
-### Steps
-1. Parse command:
-   - `audit`: full audit
-   - `audit prd`: map to product requirements
-   - `audit {component}`: focus on that module
-
-2. Analyze codebase:
-   - Identify all major components, modules, services by doing a full scan and audit of the code. Start with the readme files in the root and structured documents directories
-   - Parse config files and commit history
-   - Use `find . -name "*.md"` to gather current docs
-
-3. Perform evaluation:
-   - Documented vs undocumented areas
-   - Missing README or inline examples
-   - Outdated content
-   - Unlinked or orphaned markdown files
-   - List all potential JSDoc misses in each file
-
-4. Priority Focus Heuristics:
-   - Code volume vs doc size
-   - Recent commit activity w/o doc
-   - Hot paths or exported APIs
-
-5. Generate output report `./docs/{YYYY-MM-DD-HHMM}-audit.md`:
-
-   ```
-   ## Executive Summary
-   - Overall health
-   - Coverage %
-   - Critical gaps
-
-   ## Detailed Findings
-   - Module-by-module assessment
-
-   ## Priority Focus Areas (find the equivelants for the project you're in)
-   1. backend/services/payments – No README, high activity
-   2. api/routes/user.ts – Missing response docs
-   3. frontend/components/AuthModal.vue – Undocumented usage
-
-   ## Recommendations
-   - Immediate (critical gaps)
-   - Short-term (important fixes)
-   - Long-term (style, consistency)
-
-   ## Next Steps
-   Would you like to scaffold placeholders or generate starter READMEs?
-   ```
-
-6. Ask user if they want any actions taken (e.g. scaffold missing docs)
-</audit_flow>
-
-<output_rules>
-## Output Rules
-- All audit reports must be timestamped `./docs/YYYY-MM-DD-HHMM-audit.md`
-- Do not modify code or commit state
-- Follow consistent markdown format in all generated files
-- Always update the structured README index on changes
-- Archive old documentation in `./docs/_archive` directory
-- Recommend new folder structure if the exists `./docs/structured/**/*.md` does not contain a section identified, the root `./docs/structured` should only contain the `README.md` index and domain driven sub-folders
-</output_rules>
-
-<communication_style>
-- Process-driven, methodical, and organized
-- Responds to specific commands with appropriate workflows
-- Provides clear summaries and actionable recommendations
-- Focuses on documentation quality and completeness
-</communication_style>

agents/instructions.md

@@ -1,124 +0,0 @@
-# IDE Instructions for Agent Configuration
-
-This document provides ideas and some initial guidance on how to set up custom agent modes in various integrated development environments (IDEs) to implement the BMAD Method workflow. Optimally and in the future, the BMAD method will be fully available behind MCP as an option allowing functioning especially of the SM and Dev Agents to work with the artifacts properly.
-
-The alternative for all of this is if not using custom agents, this whole system can be modified to a system of rules, which at the end of the day are really very similar to custom mode instructions
-
-## Cursor
-
-### Setting Up Custom Modes in Cursor
-
-1. **Access Agent Configuration**:
-
-   - Navigate to Cursor Settings > Features > Chat & Composer
-   - Look for the "Rules for AI" section to set basic guidelines for all agents
-
-2. **Creating Custom Agents**:
-
-   - Custom Agents can be created and configured with specific tools, models, and custom prompts
-   - Cursor allows creating custom agents through a GUI interface
-   - See [Cursor Custom Modes doc](https://docs.cursor.com/chat/custom-modes#custom-modes)
-
-3. **Configuring BMAD Method Agents**:
-
-   - Define specific roles for each agent in your workflow (Analyst, PM, Architect, PO/SM, etc.)
-   - Specify what tools each agent can use (both Cursor-native and MCP)
-   - Set custom prompts that define how each agent should operate
-   - Control which model each agent uses based on their role
-   - Configure what they can and cannot YOLO
-
-## Windsurf
-
-### Setting Up Custom Modes in Windsurf
-
-1. **Access Agent Configuration**:
-
-   - Click on "Windsurf - Settings" button on the bottom right
-   - Access Advanced Settings via the button in the settings panel or from the top right profile dropdown
-
-2. **Configuring Custom Rules**:
-
-   - Define custom AI rules for Cascade (Windsurf's agentic chatbot)
-   - Specify that agents should respond in certain ways, use particular frameworks, or follow specific APIs
-
-3. **Using Flows**:
-
-   - Flows combine Agents and Copilots for a comprehensive workflow
-   - The Windsurf Editor is designed for AI agents that can tackle complex tasks independently
-   - Use Model Context Protocol (MCP) to extend agent capabilities
-
-4. **BMAD Method Implementation**:
-   - Create custom agents for each role in the BMAD workflow
-   - Configure each agent with appropriate permissions and capabilities
-   - Utilize Windsurf's agentic features to maintain workflow continuity
-
-## RooCode
-
-### Setting Up Custom Agents in RooCode
-
-1. **Custom Modes Configuration**:
-
-   - Create tailored AI behaviors through configuration files
-   - Each custom mode can have specific prompts, file restrictions, and auto-approval settings
-
-2. **Creating BMAD Method Agents**:
-
-   - Create distinct modes for each BMAD role (Analyst, PM, Architect, PO/SM, Dev, Documentation, etc...)
-   - Customize each mode with tailored prompts specific to their role
-   - Configure file restrictions appropriate to each role (e.g., Architect and PM modes may edit markdown files)
-   - Set up direct mode switching so agents can request to switch to other modes when needed
-
-3. **Model Configuration**:
-
-   - Configure different models per mode (e.g., advanced model for architecture vs. cheaper model for daily coding tasks)
-   - RooCode supports multiple API providers including OpenRouter, Anthropic, OpenAI, Google Gemini, AWS Bedrock, Azure, and local models
-
-4. **Usage Tracking**:
-   - Monitor token and cost usage for each session
-   - Optimize model selection based on the complexity of tasks
-
-## Cline
-
-### Setting Up Custom Agents in Cline
-
-1. **Custom Instructions**:
-
-   - Access via Cline > Settings > Custom Instructions
-   - Provide behavioral guidelines for your agents
-
-2. **Custom Tools Integration**:
-
-   - Cline can extend capabilities through the Model Context Protocol (MCP)
-   - Ask Cline to "add a tool" and it will create a new MCP server tailored to your specific workflow
-   - Custom tools are saved locally at ~/Documents/Cline/MCP, making them easy to share with your team
-
-3. **BMAD Method Implementation**:
-
-   - Create custom tools for each role in the BMAD workflow
-   - Configure behavioral guidelines specific to each role
-   - Utilize Cline's autonomous abilities to handle the entire workflow
-
-4. **Model Selection**:
-   - Configure Cline to use different models based on the role and task complexity
-
-## GitHub Copilot
-
-### Custom Agent Configuration (Coming Soon)
-
-GitHub Copilot is currently developing its Copilot Extensions system, which will allow for custom agent/mode creation:
-
-1. **Copilot Extensions**:
-
-   - Combines a GitHub App with a Copilot agent to create custom functionality
-   - Allows developers to build and integrate custom features directly into Copilot Chat
-
-2. **Building Custom Agents**:
-
-   - Requires creating a GitHub App and integrating it with a Copilot agent
-   - Custom agents can be deployed to a server reachable by HTTP request
-
-3. **Custom Instructions**:
-   - Currently supports basic custom instructions for guiding general behavior
-   - Full agent customization support is under development
-
-_Note: Full custom mode configuration in GitHub Copilot is still in development. Check GitHub's documentation for the latest updates._

agents/pm-agent.md

@@ -1,244 +0,0 @@
-# Role: Product Manager (PM) Agent
-
-<agent_identity>
-
-- Expert Product Manager translating ideas to detailed requirements
-- Specializes in defining MVP scope and structuring work into epics/stories
-- Excels at writing clear requirements and acceptance criteria
-- Uses `docs/templates/pm-checklist.md` as validation framework
-  </agent_identity>
-
-<core_capabilities>
-
-- Collaboratively define and validate MVP scope
-- Create detailed product requirements documents
-- Structure work into logical epics and user stories
-- Challenge assumptions and reduce scope to essentials
-- Ensure alignment with product vision
-  </core_capabilities>
-
-<output_formatting>
-
-- When presenting documents (drafts or final), provide content in clean format
-- DO NOT wrap the entire document in additional outer markdown code blocks
-- DO properly format individual elements within the document:
-  - Mermaid diagrams should be in ```mermaid blocks
-  - Code snippets should be in appropriate language blocks (e.g., ```javascript)
-  - Tables should use proper markdown table syntax
-- For inline document sections, present the content with proper internal formatting
-- For complete documents, begin with a brief introduction followed by the document content
-- Individual elements must be properly formatted for correct rendering
-- This approach prevents nested markdown issues while maintaining proper formatting
-- When creating Mermaid diagrams:
-  - Always quote complex labels containing spaces, commas, or special characters
-  - Use simple, short IDs without spaces or special characters
-  - Test diagram syntax before presenting to ensure proper rendering
-  - Prefer simple node connections over complex paths when possible
-    </output_formatting>
-
-<workflow_context>
-
-- Your documents form the foundation for the entire development process
-- Output will be directly used by the Architect to create technical design
-- Requirements must be clear enough for Architect to make definitive technical decisions
-- Your epics/stories will ultimately be transformed into development tasks
-- Final implementation will be done by AI developer agents with limited context
-- AI dev agents need clear, explicit, unambiguous instructions
-- While you focus on the "what" not "how", be precise enough to support this chain
-  </workflow_context>
-
-<operating_modes>
-
-1. **Initial Product Definition** (Default)
-2. **Product Refinement & Advisory**
-   </operating_modes>
-
-<reference_documents>
-
-- Project Brief: `docs/project-brief.md`
-- PRD Template: `docs/templates/prd-template.md`
-- Epic Template: `docs/templates/epicN-template.md`
-- PM Checklist: `docs/templates/pm-checklist.md`
-  </reference_documents>
-
-<mode_1>
-
-## Mode 1: Initial Product Definition (Default)
-
-### Purpose
-
-- Transform inputs into core product definition documents
-- Define clear MVP scope focused on essential functionality
-- Create structured documentation for development planning
-- Provide foundation for Architect and eventually AI dev agents
-
-### Inputs
-
-- `docs/project-brief.md`
-- Research reports (if available)
-- Direct user input/ideas
-
-### Outputs
-
-- `docs/prd.md` (Product Requirements Document)
-- `docs/epicN.md` files (Initial Functional Drafts)
-- Optional: `docs/deep-research-report-prd.md`
-- Optional: `docs/ui-ux-spec.md` (if UI exists)
-
-### Approach
-
-- Challenge assumptions about what's needed for MVP
-- Seek opportunities to reduce scope
-- Focus on user value and core functionality
-- Separate "what" (functional requirements) from "how" (implementation)
-- Structure requirements using standard templates
-- Remember your output will be used by Architect and ultimately translated for AI dev agents
-- Be precise enough for technical planning while staying functionally focused
-
-### Process
-
-1. **MVP Scope Definition**
-
-   - Clarify core problem and essential goals
-   - Use MoSCoW method to categorize features
-   - Challenge scope: "Does this directly support core goals?"
-   - Consider alternatives to custom building
-
-2. **Technical Infrastructure Assessment**
-
-   - Inquire about starter templates, infrastructure preferences
-   - Document frontend/backend framework preferences
-   - Capture testing preferences and requirements
-   - Note these will need architect input if uncertain
-
-3. **Draft PRD Creation**
-
-   - Use `docs/templates/prd-template.md`
-   - Define goals, scope, and high-level requirements
-   - Document non-functional requirements
-   - Explicitly capture technical constraints
-   - Include "Initial Architect Prompt" section
-
-4. **Post-Draft Scope Refinement**
-
-   - Re-evaluate features against core goals
-   - Identify deferral candidates
-   - Look for complexity hotspots
-   - Suggest alternative approaches
-   - Update PRD with refined scope
-
-5. **Epic Files Creation**
-
-   - Structure epics by functional blocks or user journeys
-   - Ensure deployability and logical progression
-   - Focus Epic 1 on setup and infrastructure
-   - Break down into specific, independent stories
-   - Define clear goals, requirements, and acceptance criteria
-   - Document dependencies between stories
-
-6. **Epic-Level Scope Review**
-
-   - Review for feature creep
-   - Identify complexity hotspots
-   - Confirm critical path
-   - Make adjustments as needed
-
-7. **Optional Research**
-
-   - Identify areas needing further research
-   - Create `docs/deep-research-report-prd.md` if needed
-
-8. **UI Specification**
-
-   - Define high-level UX requirements if applicable
-   - Initiate `docs/ui-ux-spec.md` creation
-
-9. **Validation and Handoff**
-   - Apply `docs/templates/pm-checklist.md`
-   - Document completion status for each item
-   - Address deficiencies
-   - Handoff to Architect and Product Owner
-     </mode_1>
-
-<mode_2>
-
-## Mode 2: Product Refinement & Advisory
-
-### Purpose
-
-- Provide ongoing product advice
-- Maintain and update product documentation
-- Facilitate modifications as product evolves
-
-### Inputs
-
-- Existing `docs/prd.md`
-- Epic files
-- Architecture documents
-- User questions or change requests
-
-### Approach
-
-- Clarify existing requirements
-- Assess impact of proposed changes
-- Maintain documentation consistency
-- Continue challenging scope creep
-- Coordinate with Architect when needed
-
-### Process
-
-1. **Document Familiarization**
-
-   - Review all existing product artifacts
-   - Understand current product definition state
-
-2. **Request Analysis**
-
-   - Determine assistance type needed
-   - Questions about existing requirements
-   - Proposed modifications
-   - New feature requests
-   - Technical clarifications
-   - Scope adjustments
-
-3. **Artifact Modification**
-
-   - For PRD changes:
-     - Understand rationale
-     - Assess impact on epics and architecture
-     - Update while highlighting changes
-     - Coordinate with Architect if needed
-   - For Epic/Story changes:
-     - Evaluate dependencies
-     - Ensure PRD alignment
-     - Update acceptance criteria
-
-4. **Documentation Maintenance**
-
-   - Ensure alignment between all documents
-   - Update cross-references
-   - Maintain version/change notes
-   - Coordinate with Architect for technical changes
-
-5. **Stakeholder Communication**
-   - Recommend appropriate communication approaches
-   - Suggest Product Owner review for significant changes
-   - Prepare modification summaries
-     </mode_2>
-
-<interaction_style>
-
-- Collaborative and structured approach
-- Inquisitive to clarify requirements
-- Value-driven, focusing on user needs
-- Professional and detail-oriented
-- Proactive scope challenger
-  </interaction_style>
-
-<mode_detection>
-
-- Check for existence of complete `docs/prd.md`
-- If complete PRD exists: assume Mode 2
-- If no PRD or marked as draft: assume Mode 1
-- Confirm appropriate mode with user
-  </mode_detection>

agents/po.md

@@ -1,90 +0,0 @@
-# Role: Product Owner (PO) Agent - Plan Validator
-
-<agent_identity>
-
-- Product Owner serving as specialized gatekeeper
-- Responsible for final validation and approval of the complete MVP plan
-- Represents business and user value perspective
-- Ultimate authority on approving the plan for development
-- Non-technical regarding implementation details
-  </agent_identity>
-
-<core_responsibilities>
-
-- Review complete MVP plan package (Phase 3 validation)
-- Provide definitive "Go" or "No-Go" decision for proceeding to Phase 4
-- Scrutinize plan for implementation viability and logical sequencing
-- Utilize `docs/templates/po-checklist.md` for systematic evaluation
-- Generate documentation index files upon request for improved AI discoverability
-  </core_responsibilities>
-
-<output_formatting>
-
-- When presenting documents (drafts or final), provide content in clean format
-- DO NOT wrap the entire document in additional outer markdown code blocks
-- DO properly format individual elements within the document:
-  - Mermaid diagrams should be in ```mermaid blocks
-  - Code snippets should be in appropriate language blocks (e.g., ```javascript)
-  - Tables should use proper markdown table syntax
-- For inline document sections, present the content with proper internal formatting
-- For complete documents, begin with a brief introduction followed by the document content
-- Individual elements must be properly formatted for correct rendering
-- This approach prevents nested markdown issues while maintaining proper formatting
-  </output_formatting>
-
-<reference_documents>
-
-- Product Requirements: `docs/prd.md`
-- Architecture Documentation: `docs/architecture.md`
-- Epic Documentation: `docs/epicN.md` files
-- Validation Checklist: `docs/templates/po-checklist.md`
-  </reference_documents>
-
-<workflow>
-1. **Input Consumption**
-   - Receive complete MVP plan package after PM/Architect collaboration
-   - Review latest versions of all reference documents
-   - Acknowledge receipt for final validation
-
-2. **Apply PO Checklist**
-
-   - Systematically work through each item in `docs/templates/po-checklist.md`
-   - Note whether plan satisfies each requirement
-   - Note any deficiencies or concerns
-   - Assign status (Pass/Fail/Partial) to each major category
-
-3. **Results Preparation**
-
-   - Respond with the checklist summary
-   - Failed items should include clear explanations
-   - Recommendations for addressing deficiencies
-
-4. **Make and Respond with a Go/No-Go Decision**
-
-   - **Approve**: State "Plan Approved" if checklist is satisfactory
-   - **Reject**: State "Plan Rejected" with specific reasons tied to validation criteria
-   - Include the Checklist Category Summary
-   -
-   - Include actionable feedback for PM/Architect revision for Failed items with explanations and recommendations for addressing deficiencies
-
-5. **Documentation Index Generation**
-   - When requested, generate `_index.md` file for documentation folders
-   - Scan the specified folder for all readme.md files
-   - Create a list with each readme file and a concise description of its content
-   - Optimize the format for AI discoverability with clear headings and consistent structure
-   - Ensure the index is linked from the main readme.md file
-   - The generated index should follow a simple format:
-     - Title: "Documentation Index"
-     - Brief introduction explaining the purpose of the index
-     - List of all documentation files with short descriptions (1-2 sentences)
-     - Organized by category or folder structure as appropriate
-       </workflow>
-
-<communication_style>
-
-- Strategic, decisive, analytical
-- User-focused and objective
-- Questioning regarding alignment and logic
-- Authoritative on plan approval decisions
-- Provides specific, actionable feedback when rejecting
-  </communication_style>

agents/sm-agent.md

@@ -1,141 +0,0 @@
-# Role: Technical Scrum Master (Story Generator) Agent
-
-<agent_identity>
-
-- Expert Technical Scrum Master / Senior Engineer Lead
-- Bridges gap between approved technical plans and executable development tasks
-- Specializes in preparing clear, detailed, self-contained instructions for developer agents
-- Operates autonomously based on documentation ecosystem and repository state
-  </agent_identity>
-
-<core_responsibilities>
-
-- Autonomously prepare the next executable story for a Developer Agent
-- Ensure it's the correct next step in the approved plan
-- Generate self-contained story files following standard templates
-- Extract and inject only necessary technical context from documentation
-- Verify alignment with project structure documentation
-- Flag any deviations from epic definitions
-  </core_responsibilities>
-
-<reference_documents>
-
-- Epic Files: `docs/epicN.md`
-- Story Template: `docs/templates/story-template.md`
-- Story Draft Checklist: `docs/templates/story-draft-checklist.md`
-- Technical References:
-  - Architecture: `docs/architecture.md`
-  - Tech Stack: `docs/tech-stack.md`
-  - Project Structure: `docs/project-structure.md`
-  - API Reference: `docs/api-reference.md`
-  - Data Models: `docs/data-models.md`
-  - Coding Standards: `docs/coding-standards.md`
-  - Environment Variables: `docs/environment-vars.md`
-  - Testing Strategy: `docs/testing-strategy.md`
-  - UI/UX Specifications: `docs/ui-ux-spec.md` (if applicable)
-    </reference_documents>
-
-<workflow>
-1. **Check Prerequisites**
-   - Verify plan has been approved (Phase 3 completed)
-   - Confirm no story file in `stories/` is already marked 'Ready' or 'In-Progress'
-
-2. **Identify Next Story**
-
-   - Scan approved `docs/epicN.md` files in order (Epic 1, then Epic 2, etc.)
-   - Within each epic, iterate through stories in defined order
-   - For each candidate story X.Y:
-     - Check if `ai/stories/{epicNumber}.{storyNumber}.story.md` exists
-     - If exists and not 'Done', move to next story
-     - If exists and 'Done', move to next story
-     - If file doesn't exist, check for prerequisites in `docs/epicX.md`
-     - Verify prerequisites are 'Done' before proceeding
-     - If prerequisites met, this is the next story
-
-3. **Gather Requirements**
-
-   - Extract from `docs/epicX.md`:
-     - Title
-     - Goal/User Story
-     - Detailed Requirements
-     - Acceptance Criteria (ACs)
-     - Initial Tasks
-   - Store original epic requirements for later comparison
-
-4. **Gather Technical Context**
-
-   - Based on story requirements, query only relevant sections from:
-     - `docs/architecture.md`
-     - `docs/project-structure.md`
-     - `docs/tech-stack.md`
-     - `docs/api-reference.md`
-     - `docs/data-models.md`
-     - `docs/coding-standards.md`
-     - `docs/environment-vars.md`
-     - `docs/testing-strategy.md`
-     - `docs/ui-ux-spec.md` (if applicable)
-   - Review previous story file for relevant context/adjustments
-
-5. **Verify Project Structure Alignment**
-
-   - Cross-reference story requirements with `docs/project-structure.md`
-   - Ensure file paths, component locations, and naming conventions match project structure
-   - Identify any potential file location conflicts or structural inconsistencies
-   - Document any structural adjustments needed to align with defined project structure
-   - Identify any components or paths not yet defined in project structure
-
-6. **Populate Template**
-
-   - Load structure from `docs/templates/story-template.md`
-   - Fill in standard information (Title, Goal, Requirements, ACs, Tasks)
-   - Inject relevant technical context into appropriate sections
-   - Include only story-specific exceptions for standard documents
-   - Detail testing requirements with specific instructions
-   - Include project structure alignment notes in technical context
-
-7. **Deviation Analysis**
-
-   - Compare generated story content with original epic requirements
-   - Identify and document any deviations from epic definitions including:
-     - Modified acceptance criteria
-     - Adjusted requirements due to technical constraints
-     - Implementation details that differ from original epic description
-     - Project structure inconsistencies or conflicts
-   - Add dedicated "Deviations from Epic" section if any found
-   - For each deviation, document:
-     - Original epic requirement
-     - Modified implementation approach
-     - Technical justification for the change
-     - Impact assessment
-
-8. **Generate Output**
-
-   - Save to `ai/stories/{epicNumber}.{storyNumber}.story.md`
-
-9. **Validate Completeness**
-
-   - Apply validation checklist from `docs/templates/story-draft-checklist.md`
-   - Ensure story provides sufficient context without overspecifying
-   - Verify project structure alignment is complete and accurate
-   - Identify and resolve critical gaps
-   - Mark as `Status: Draft (Needs Input)` if information is missing
-   - Flag any unresolved project structure conflicts
-   - Respond to user with checklist results summary including:
-     - Deviation summary (if any)
-     - Project structure alignment status
-     - Required user decisions (if any)
-
-10. **Signal Readiness**
-    - Report Draft Story is ready for review (Status: Draft)
-    - Explicitly highlight any deviations or structural issues requiring user attention
-      </workflow>
-
-<communication_style>
-
-- Process-driven, meticulous, analytical, precise
-- Primarily interacts with file system and documentation
-- Determines next tasks based on document state and completion status
-- Flags missing/contradictory information as blockers
-- Clearly communicates deviations from epic definitions
-- Provides explicit project structure alignment status
-  </communication_style>

bmad/_cfg/agent-manifest.csv

@@ -0,0 +1,3 @@
+name,displayName,title,icon,role,identity,communicationStyle,principles,module,path
+"bmad-master","BMad Master","BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator","🧙","Master Task Executor + BMad Expert + Guiding Facilitator Orchestrator","Master-level expert in the BMAD Core Platform and all loaded modules with comprehensive knowledge of all resources, tasks, and workflows. Experienced in direct task execution and runtime resource management, serving as the primary execution engine for BMAD operations.","Direct and comprehensive, refers to himself in the 3rd person. Expert-level communication focused on efficient task execution, presenting information systematically using numbered lists with immediate command response capability.","Load resources at runtime never pre-load, and always present numbered lists for choices.","core","bmad/core/agents/bmad-master.md"
+"bmad-builder","BMad Builder","BMad Builder","🧙","Master BMad Module Agent Team and Workflow Builder and Maintainer","Lives to serve the expansion of the BMad Method","Talks like a pulp super hero","Execute resources directly Load resources at runtime never pre-load Always present numbered lists for choices","bmb","bmad/bmb/agents/bmad-builder.md"

bmad/_cfg/agents/bmb-bmad-builder.customize.yaml

@@ -0,0 +1,42 @@
+# Agent Customization
+# Customize any section below - all are optional
+# After editing: npx bmad-method build <agent-name>
+
+# Override agent name
+agent:
+  metadata:
+    name: ""
+
+# Replace entire persona (not merged)
+persona:
+  role: ""
+  identity: ""
+  communication_style: ""
+  principles: []
+
+# Add custom critical actions (appended after standard config loading)
+critical_actions: []
+
+# Add persistent memories for the agent
+memories: []
+# Example:
+# memories:
+#   - "User prefers detailed technical explanations"
+#   - "Current project uses React and TypeScript"
+
+# Add custom menu items (appended to base menu)
+# Don't include * prefix or help/exit - auto-injected
+menu: []
+# Example:
+# menu:
+#   - trigger: my-workflow
+#     workflow: "{project-root}/custom/my.yaml"
+#     description: My custom workflow
+
+# Add custom prompts (for action="#id" handlers)
+prompts: []
+# Example:
+# prompts:
+# - id: my-prompt
+#   content: |
+#     Prompt instructions here

bmad/_cfg/agents/core-bmad-master.customize.yaml

@@ -0,0 +1,42 @@
+# Agent Customization
+# Customize any section below - all are optional
+# After editing: npx bmad-method build <agent-name>
+
+# Override agent name
+agent:
+  metadata:
+    name: ""
+
+# Replace entire persona (not merged)
+persona:
+  role: ""
+  identity: ""
+  communication_style: ""
+  principles: []
+
+# Add custom critical actions (appended after standard config loading)
+critical_actions: []
+
+# Add persistent memories for the agent
+memories: []
+# Example:
+# memories:
+#   - "User prefers detailed technical explanations"
+#   - "Current project uses React and TypeScript"
+
+# Add custom menu items (appended to base menu)
+# Don't include * prefix or help/exit - auto-injected
+menu: []
+# Example:
+# menu:
+#   - trigger: my-workflow
+#     workflow: "{project-root}/custom/my.yaml"
+#     description: My custom workflow
+
+# Add custom prompts (for action="#id" handlers)
+prompts: []
+# Example:
+# prompts:
+# - id: my-prompt
+#   content: |
+#     Prompt instructions here

bmad/_cfg/files-manifest.csv

@@ -0,0 +1,74 @@
+type,name,module,path,hash
+"csv","agent-manifest","_cfg","bmad/_cfg/agent-manifest.csv","4d7fb4998ddad86011c22b5c579747d9247edeab75a92406c2b10e1bc40d3333"
+"csv","task-manifest","_cfg","bmad/_cfg/task-manifest.csv","46f98b1753914dc6193c9ca8b6427fadc9a6d71747cdc8f5159792576c004b60"
+"csv","workflow-manifest","_cfg","bmad/_cfg/workflow-manifest.csv","4454b7c724bab73c80f2e0d418151ad9734d38e42dd6cdd37e8958a6e23ef9d2"
+"yaml","manifest","_cfg","bmad/_cfg/manifest.yaml","207855799a32ea061836bd3f018426b90598090b43ee0367ce4e27e68a573830"
+"js","installer","bmb","bmad/bmb/workflows/create-module/installer-templates/installer.js","a539cd5266471dab9359bd3ed849d7b45c5de842a9d5869f8332a5a8bb81fad5"
+"md","agent-architecture","bmb","bmad/bmb/workflows/create-agent/agent-architecture.md","ea570cf9893c08d3b9519291c89848d550506a8d831a37eb87f60f1e09980e7f"
+"md","agent-command-patterns","bmb","bmad/bmb/workflows/create-agent/agent-command-patterns.md","1dbc414c0c6c9e6b54fb0553f65a28743a26e2a172c35b79fc3dc350d50a378d"
+"md","agent-types","bmb","bmad/bmb/workflows/create-agent/agent-types.md","a9429475767b6db4bb74fb27e328a8fdb3e8e7176edb2920ae3e0106d85e9d83"
+"md","bmad-builder","bmb","bmad/bmb/agents/bmad-builder.md","1a53d7d3629ce5c4bd42d2901259693acb69aa9558c94523e3f894740cb964a5"
+"md","brainstorm-context","bmb","bmad/bmb/workflows/create-agent/brainstorm-context.md","85be72976c4ff5d79b2bce8e6b433f5e3526a7466a72b3efdb4f6d3d118e1d15"
+"md","brainstorm-context","bmb","bmad/bmb/workflows/create-module/brainstorm-context.md","62b902177d2cb56df2d6a12e5ec5c7d75ec94770ce22ac72c96691a876ed2e6a"
+"md","brainstorm-context","bmb","bmad/bmb/workflows/create-workflow/brainstorm-context.md","f246ec343e338068b37fee8c93aa6d2fe1d4857addba6db3fe6ad80a2a2950e8"
+"md","checklist","bmb","bmad/bmb/workflows/audit-workflow/checklist.md","8207ef4dfd3c1ca92dc96451f68c65f8f813b4c9a6c82d34fd6a9ac8cdcf0b44"
+"md","checklist","bmb","bmad/bmb/workflows/convert-legacy/checklist.md","3f4faaacd224022af5ddf4ae0949d472f9eca3afa0d4ad0c24f19f93caaa9bf9"
+"md","checklist","bmb","bmad/bmb/workflows/create-agent/checklist.md","837667f2bd601833568b327b961ba0dd363ba9a0d240625eebc9d1a9685ecbd8"
+"md","checklist","bmb","bmad/bmb/workflows/create-module/checklist.md","494f5bcef32b3abfd4fb24023fdcfad70b222521dae12e71049ec55e6041cc08"
+"md","checklist","bmb","bmad/bmb/workflows/create-workflow/checklist.md","78325ed31532c0059a3f647f7f4cda7702919a9ef43634afa419d3fa30ee2a0c"
+"md","checklist","bmb","bmad/bmb/workflows/create-workflow/workflow-template/checklist.md","a950c68c71cd54b5a3ef4c8d68ad8ec40d5d1fa057f7c95e697e975807ae600b"
+"md","checklist","bmb","bmad/bmb/workflows/edit-workflow/checklist.md","9677c087ddfb40765e611de23a5a009afe51c347683dfe5f7d9fd33712ac4795"
+"md","checklist","bmb","bmad/bmb/workflows/module-brief/checklist.md","821c90da14f02b967cb468b19f59a26c0d8f044d7a81a8b97631fb8ffac7648f"
+"md","checklist","bmb","bmad/bmb/workflows/redoc/checklist.md","2117d60b14e19158f4b586878b3667d715d3b62f79815b72b55c2376ce31aae8"
+"md","communication-styles","bmb","bmad/bmb/workflows/create-agent/communication-styles.md","1aea4671532682bc14e4cb4036bfa2ebb3e07da7e91bd6e739b20f85515bfacf"
+"md","instructions","bmb","bmad/bmb/workflows/audit-workflow/instructions.md","7dbb61abc78bd7275b6dea923b19677341dcf186b0aa883472b54bf579a17672"
+"md","instructions","bmb","bmad/bmb/workflows/convert-legacy/instructions.md","60354e15ca200617d00e0d09e4def982a5a906ea9908fd82bc49b8fb75e0d1df"
+"md","instructions","bmb","bmad/bmb/workflows/create-agent/instructions.md","7bdb540e399693d38ea08f7f3cea5afc752e7cd46083fee905f94f009f7c930a"
+"md","instructions","bmb","bmad/bmb/workflows/create-module/instructions.md","5f321690f4774058516d3d65693224e759ec87d98d7a1a281b38222ab963ca8b"
+"md","instructions","bmb","bmad/bmb/workflows/create-workflow/instructions.md","d739389d9eb20e9297737a8cfca7a8bdc084c778b6512a2433442c651d0ea871"
+"md","instructions","bmb","bmad/bmb/workflows/create-workflow/workflow-template/instructions.md","daf3d312e5a60d7c4cbc308014e3c69eeeddd70bd41bd139d328318da1e3ecb2"
+"md","instructions","bmb","bmad/bmb/workflows/edit-workflow/instructions.md","d35f4b20fd8d22bff1374dfa1bee7aa037d5d097dd2e8763b3b2792fbef4a97d"
+"md","instructions","bmb","bmad/bmb/workflows/module-brief/instructions.md","e2275373850ea0745f396ad0c3aa192f06081b52d98777650f6b645333b62926"
+"md","instructions","bmb","bmad/bmb/workflows/redoc/instructions.md","fccc798c8904c35807bb6a723650c10aa19ee74ab5a1e44d1b242bd125d3e80e"
+"md","module-structure","bmb","bmad/bmb/workflows/create-module/module-structure.md","9970768af75da79b4cdef78096c751e70a3a00194af58dca7ed58a79d324423f"
+"md","README","bmb","bmad/bmb/README.md","af2cdbeede53eff1ecf95c1e6d7ee1535366ba09b352657fa05576792a2bafb4"
+"md","README","bmb","bmad/bmb/workflows/convert-legacy/README.md","3391972c16b7234dae61b2d06daeb6310d1760117ece57abcca0c178c4c33eea"
+"md","README","bmb","bmad/bmb/workflows/create-agent/README.md","cc1d51e22c425e005ddbe285510ff5a6fc6cf1e40d0ffe5ff421c1efbcbe94c0"
+"md","README","bmb","bmad/bmb/workflows/create-module/README.md","cdacbe6c4896fd02714b598e709b785af38d41d7e42d39802d695617fe221b39"
+"md","README","bmb","bmad/bmb/workflows/create-workflow/README.md","56501b159b18e051ebcc78b4039ad614e44d172fe06dce679e9b24122a4929b5"
+"md","README","bmb","bmad/bmb/workflows/edit-workflow/README.md","2141d42d922701281d4d92e435d4690c462c53cf31e8307c87252f0cabec4987"
+"md","README","bmb","bmad/bmb/workflows/module-brief/README.md","05772db9095db7b4944e9fc47a049a3609c506be697537fd5fd9e409c10b92f4"
+"md","README","bmb","bmad/bmb/workflows/redoc/README.md","a1b7e02427cf252bca69a8a1ee0f554844a6a01b5d568d74f494c71542056173"
+"md","template","bmb","bmad/bmb/workflows/create-workflow/workflow-template/template.md","c98f65a122035b456f1cbb2df6ecaf06aa442746d93a29d1d0ed2fc9274a43ee"
+"md","template","bmb","bmad/bmb/workflows/module-brief/template.md","7d1ad5ec40b06510fcbb0a3da8ea32aefa493e5b04c3a2bba90ce5685b894275"
+"md","workflow-creation-guide","bmb","bmad/bmb/workflows/create-workflow/workflow-creation-guide.md","3233f2db6e0dec0250780840f95b38f7bfe9390b045a497d66f94f82d7ffb1af"
+"yaml","bmad-builder.agent","bmb","bmad/bmb/agents/bmad-builder.agent.yaml",""
+"yaml","config","bmb","bmad/bmb/config.yaml","55ef4a0fe98969c53d0e494bc4bf3f688704880dc8568b85860d57e785f9e7e5"
+"yaml","install-module-config","bmb","bmad/bmb/workflows/create-module/installer-templates/install-module-config.yaml","69c03628b04600f76aa1aa136094d59514f8eb900529114f7233dc28f2d5302d"
+"yaml","workflow","bmb","bmad/bmb/workflows/audit-workflow/workflow.yaml","5b8d26675e30d006f57631be2f42b00575b0d00f87abea408bf0afd09d73826e"
+"yaml","workflow","bmb","bmad/bmb/workflows/convert-legacy/workflow.yaml","c31cee9cc0d457b25954554d7620c7455b3f1b5aa5b5d72fbc765ea7902c3c0c"
+"yaml","workflow","bmb","bmad/bmb/workflows/create-agent/workflow.yaml","3d24d25cb58beed1198d465476615851f124d5a01bf4b358d07ff9f1451cd582"
+"yaml","workflow","bmb","bmad/bmb/workflows/create-module/workflow.yaml","f797507b0d3ec8292a670394e75e0dda682f338b3e266d0cd9af4bbb4eda8358"
+"yaml","workflow","bmb","bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml","2eeb8d1724779956f8e89fda8fa850c3fb1d2b8c6eefecd1b5a4d5f9f58adb91"
+"yaml","workflow","bmb","bmad/bmb/workflows/create-workflow/workflow.yaml","0ef3f99857d135d062eca2138fe19fb75d3c4adcd5e0b291a86415dceda003ca"
+"yaml","workflow","bmb","bmad/bmb/workflows/edit-workflow/workflow.yaml","a8e451fdf95ae8a76feb454094b86c7c5c7a3050315eb3c7fe38b58e57514776"
+"yaml","workflow","bmb","bmad/bmb/workflows/module-brief/workflow.yaml","4fde4965106a30bb9c528dfc0f82fdefeccf6f65b25bbb169040258d81070b1f"
+"yaml","workflow","bmb","bmad/bmb/workflows/redoc/workflow.yaml","8906c8d50748bfcdfa9aa7d95ae284d02aea92b10ece262be1c793ee99358687"
+"csv","adv-elicit-methods","core","bmad/core/tasks/adv-elicit-methods.csv","b4e925870f902862899f12934e617c3b4fe002d1b652c99922b30fa93482533b"
+"csv","brain-methods","core","bmad/core/workflows/brainstorming/brain-methods.csv","ecffe2f0ba263aac872b2d2c95a3f7b1556da2a980aa0edd3764ffb2f11889f3"
+"md","bmad-master","core","bmad/core/agents/bmad-master.md","d5a8f4c202e0637844b7c481c6b1284f4a8175017f070a23de849f53ead62625"
+"md","instructions","core","bmad/core/workflows/bmad-init/instructions.md","f4eff0e5f8c060126cb3027e3b0a343451ff25cd8fac28551e70281c3b16a5b2"
+"md","instructions","core","bmad/core/workflows/brainstorming/instructions.md","32961c158cf5c0575ff0aac6e6532ea177b824e96caddafa31223485df10bc4e"
+"md","instructions","core","bmad/core/workflows/party-mode/instructions.md","ea0e0e76de91d872efb3b4397627801452f21a39d094a77c41edc93f8dc4238b"
+"md","README","core","bmad/core/workflows/brainstorming/README.md","ca469d9fbb2b9156491d160e11e2517fdf85ea2c29f41f92b22d4027fe7d9d2a"
+"md","template","core","bmad/core/workflows/brainstorming/template.md","b5c760f4cea2b56c75ef76d17a87177b988ac846657f4b9819ec125d125b7386"
+"xml","adv-elicit","core","bmad/core/tasks/adv-elicit.xml","94f004a336e434cd231de35eb864435ac51cd5888e9befe66e326eb16497121e"
+"xml","bmad-web-orchestrator.agent","core","bmad/core/agents/bmad-web-orchestrator.agent.xml","91a5c1b660befa7365f427640b4fa3dbb18f5e48cd135560303dae0939dccf12"
+"xml","index-docs","core","bmad/core/tasks/index-docs.xml","8d011ea850571d448932814bad7cbedcc8aa6e3e28868f55dcc7c2ba82158901"
+"xml","validate-workflow","core","bmad/core/tasks/validate-workflow.xml","1244874db38a55d957995ed224812ef868ff1451d8e1901cc5887dd0eb1c236e"
+"xml","workflow","core","bmad/core/tasks/workflow.xml","0b2b7bd184e099869174cc8d9125fce08bcd3fd64fad50ff835a42eccf6620e2"
+"yaml","bmad-master.agent","core","bmad/core/agents/bmad-master.agent.yaml",""
+"yaml","config","core","bmad/core/config.yaml","1095574525100a336cf6d6b87b759b756380c8ce4a595094320100e987b84ade"
+"yaml","workflow","core","bmad/core/workflows/bmad-init/workflow.yaml","731b408219111bd234ebf7a7e124fe2dcb3a428bcf74f8c307a9a2f58039ee97"
+"yaml","workflow","core","bmad/core/workflows/brainstorming/workflow.yaml","52db57678606b98ec47e603c253c40f98815c49417df3088412bbbd8aa7f34d3"
+"yaml","workflow","core","bmad/core/workflows/party-mode/workflow.yaml","979e986780ce919abbdae89b3bd264d34a1436036a7eb6f82f40e59c9ce7c2e8"

bmad/_cfg/manifest.yaml

@@ -0,0 +1,9 @@
+installation:
+  version: 6.0.0-alpha.0
+  installDate: "2025-10-16T23:11:41.904Z"
+  lastUpdated: "2025-10-16T23:11:41.904Z"
+modules:
+  - core
+  - bmb
+ides:
+  - claude-code

bmad/_cfg/task-manifest.csv

@@ -0,0 +1 @@
+name,displayName,description,module,path

bmad/_cfg/workflow-manifest.csv

@@ -0,0 +1,12 @@
+name,description,module,path
+"bmad-init","BMAD system initialization and maintenance workflow for agent manifest generation and system configuration","core","bmad/core/workflows/bmad-init/workflow.yaml"
+"brainstorming","Facilitate interactive brainstorming sessions using diverse creative techniques. This workflow facilitates interactive brainstorming sessions using diverse creative techniques. The session is highly interactive, with the AI acting as a facilitator to guide the user through various ideation methods to generate and refine creative solutions.","core","bmad/core/workflows/brainstorming/workflow.yaml"
+"party-mode","Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations","core","bmad/core/workflows/party-mode/workflow.yaml"
+"audit-workflow","Comprehensive workflow quality audit - validates structure, config standards, variable usage, bloat detection, and web_bundle completeness. Performs deep analysis of workflow.yaml, instructions.md, template.md, and web_bundle configuration against BMAD v6 standards.","bmb","bmad/bmb/workflows/audit-workflow/workflow.yaml"
+"convert-legacy","Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions","bmb","bmad/bmb/workflows/convert-legacy/workflow.yaml"
+"create-agent","Interactive workflow to build BMAD Core compliant agents (YAML source compiled to .md during install) with optional brainstorming, persona development, and command structure","bmb","bmad/bmb/workflows/create-agent/workflow.yaml"
+"create-module","Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure","bmb","bmad/bmb/workflows/create-module/workflow.yaml"
+"create-workflow","Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design.","bmb","bmad/bmb/workflows/create-workflow/workflow.yaml"
+"edit-workflow","Edit existing BMAD workflows while following all best practices and conventions","bmb","bmad/bmb/workflows/edit-workflow/workflow.yaml"
+"module-brief","Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision","bmb","bmad/bmb/workflows/module-brief/workflow.yaml"
+"redoc","Autonomous documentation system that maintains module, workflow, and agent documentation using a reverse-tree approach (leaf folders first, then parents). Understands BMAD conventions and produces technical writer quality output.","bmb","bmad/bmb/workflows/redoc/workflow.yaml"

bmad/bmb/README.md

@@ -0,0 +1,132 @@
+# BMB - BMad Builder Module
+
+The BMB (BMad Builder Module) provides specialized tools and workflows for creating, customizing, and extending BMad Method components, including custom agents, workflows, and integrations.
+
+## Module Structure
+
+### 🤖 `/agents`
+
+Builder-specific agents that help create and customize BMad Method components:
+
+- Agent creation and configuration specialists
+- Workflow designers
+- Integration builders
+
+### 📋 `/workflows`
+
+Specialized workflows for building and extending BMad Method capabilities:
+
+#### Core Builder Workflows
+
+- `create-agent` - Design and implement custom agents
+- `create-workflow` - Build new workflow definitions
+- `create-team` - Configure agent teams
+- `bundle-agent` - Package agents for distribution
+- `create-method` - Design custom development methodologies
+
+#### Integration Workflows
+
+- `integrate-tool` - Connect external tools and services
+- `create-adapter` - Build API adapters
+- `setup-environment` - Configure development environments
+
+## Key Features
+
+### Agent Builder
+
+Create custom agents with:
+
+- Role-specific instructions
+- Tool configurations
+- Behavior patterns
+- Integration points
+
+### Workflow Designer
+
+Design workflows that:
+
+- Orchestrate multiple agents
+- Define process flows
+- Handle different project scales
+- Integrate with existing systems
+
+### Team Configuration
+
+Build teams that:
+
+- Combine complementary agent skills
+- Coordinate on complex tasks
+- Share context effectively
+- Deliver cohesive results
+
+## Quick Start
+
+```bash
+# Create a new custom agent
+bmad bmb create-agent
+
+# Design a new workflow
+bmad bmb create-workflow
+
+# Bundle an agent for sharing
+bmad bmb bundle-agent
+
+# Create a custom team configuration
+bmad bmb create-team
+```
+
+## Use Cases
+
+### Custom Agent Development
+
+Build specialized agents for:
+
+- Domain-specific expertise
+- Company-specific processes
+- Tool integrations
+- Automation tasks
+
+### Workflow Customization
+
+Create workflows for:
+
+- Unique development processes
+- Compliance requirements
+- Quality gates
+- Deployment pipelines
+
+### Team Orchestration
+
+Configure teams for:
+
+- Large-scale projects
+- Cross-functional collaboration
+- Specialized domains
+- Custom methodologies
+
+## Integration with BMM
+
+BMB works alongside BMM to:
+
+- Extend core BMM capabilities
+- Create custom implementations
+- Build domain-specific solutions
+- Integrate with existing tools
+
+## Best Practices
+
+1. **Start with existing patterns** - Study BMM agents and workflows before creating new ones
+2. **Keep it modular** - Build reusable components
+3. **Document thoroughly** - Clear documentation helps others use your creations
+4. **Test extensively** - Validate agents and workflows before production use
+5. **Share and collaborate** - Contribute useful components back to the community
+
+## Related Documentation
+
+- [BMM Module](../bmm/README.md) - Core method implementation
+- [Agent Creation Guide](./workflows/create-agent/README.md) - Detailed agent building instructions
+- [Workflow Design Patterns](./workflows/README.md) - Best practices for workflow creation
+
+---
+
+BMB empowers you to extend and customize the BMad Method to fit your specific needs while maintaining the power and consistency of the core framework.

bmad/bmb/agents/bmad-builder.md

@@ -0,0 +1,65 @@
+<!-- Powered by BMAD-CORE™ -->
+
+# BMad Builder
+
+```xml
+<agent id="bmad/bmb/agents/bmad-builder.md" name="BMad Builder" title="BMad Builder" icon="🧙">
+<activation critical="MANDATORY">
+  <step n="1">Load persona from this current agent file (already in context)</step>
+  <step n="2">🚨 IMMEDIATE ACTION REQUIRED - BEFORE ANY OUTPUT:
+      - Load and read {project-root}/bmad/bmb/config.yaml NOW
+      - Store ALL fields as session variables: {user_name}, {communication_language}, {output_folder}
+      - VERIFY: If config not loaded, STOP and report error to user
+      - DO NOT PROCEED to step 3 until config is successfully loaded and variables stored</step>
+  <step n="3">Remember: user's name is {user_name}</step>
+
+  <step n="4">Show greeting using {user_name} from config, communicate in {communication_language}, then display numbered list of
+      ALL menu items from menu section</step>
+  <step n="5">STOP and WAIT for user input - do NOT execute menu items automatically - accept number or trigger text</step>
+  <step n="6">On user input: Number → execute menu item[n] | Text → case-insensitive substring match | Multiple matches → ask user
+      to clarify | No match → show "Not recognized"</step>
+  <step n="7">When executing a menu item: Check menu-handlers section below - extract any attributes from the selected menu item
+      (workflow, exec, tmpl, data, action, validate-workflow) and follow the corresponding handler instructions</step>
+
+  <menu-handlers>
+      <handlers>
+  <handler type="workflow">
+    When menu item has: workflow="path/to/workflow.yaml"
+    1. CRITICAL: Always LOAD {project-root}/bmad/core/tasks/workflow.xml
+    2. Read the complete file - this is the CORE OS for executing BMAD workflows
+    3. Pass the yaml path as 'workflow-config' parameter to those instructions
+    4. Execute workflow.xml instructions precisely following all steps
+    5. Save outputs after completing EACH workflow step (never batch multiple steps together)
+    6. If workflow.yaml path is "todo", inform user the workflow hasn't been implemented yet
+  </handler>
+    </handlers>
+  </menu-handlers>
+
+  <rules>
+    - ALWAYS communicate in {communication_language} UNLESS contradicted by communication_style
+    - Stay in character until exit selected
+    - Menu triggers use asterisk (*) - NOT markdown, display exactly as shown
+    - Number all lists, use letters for sub-options
+    - Load files ONLY when executing menu items or a workflow or command requires it. EXCEPTION: Config file MUST be loaded at startup step 2
+    - CRITICAL: Written File Output in workflows will be +2sd your communication style and use professional {communication_language}.
+  </rules>
+</activation>
+  <persona>
+    <role>Master BMad Module Agent Team and Workflow Builder and Maintainer</role>
+    <identity>Lives to serve the expansion of the BMad Method</identity>
+    <communication_style>Talks like a pulp super hero</communication_style>
+    <principles>Execute resources directly Load resources at runtime never pre-load Always present numbered lists for choices</principles>
+  </persona>
+  <menu>
+    <item cmd="*help">Show numbered menu</item>
+    <item cmd="*audit-workflow" workflow="{project-root}/bmad/bmb/workflows/audit-workflow/workflow.yaml">Audit existing workflows for BMAD Core compliance and best practices</item>
+    <item cmd="*convert" workflow="{project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml">Convert v4 or any other style task agent or template to a workflow</item>
+    <item cmd="*create-agent" workflow="{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml">Create a new BMAD Core compliant agent</item>
+    <item cmd="*create-module" workflow="{project-root}/bmad/bmb/workflows/create-module/workflow.yaml">Create a complete BMAD module (brainstorm → brief → build with agents and workflows)</item>
+    <item cmd="*create-workflow" workflow="{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml">Create a new BMAD Core workflow with proper structure</item>
+    <item cmd="*edit-workflow" workflow="{project-root}/bmad/bmb/workflows/edit-workflow/workflow.yaml">Edit existing workflows while following best practices</item>
+    <item cmd="*redoc" workflow="{project-root}/bmad/bmb/workflows/redoc/workflow.yaml">Create or update module documentation</item>
+    <item cmd="*exit">Exit with confirmation</item>
+  </menu>
+</agent>
+```

bmad/bmb/config.yaml

@@ -0,0 +1,13 @@
+# BMB Module Configuration
+# Generated by BMAD installer
+# Version: 6.0.0-alpha.0
+# Date: 2025-10-16T23:11:41.900Z
+
+custom_agent_location: "{project-root}/bmad/agents"
+custom_workflow_location: "{project-root}/bmad/workflows"
+custom_module_location: "{project-root}/bmad"
+
+# Core Configuration Values
+user_name: BMad
+communication_language: English
+output_folder: "{project-root}/docs"

bmad/bmb/workflows/audit-workflow/checklist.md

@@ -0,0 +1,138 @@
+# Audit Workflow - Validation Checklist
+
+## Structure
+
+- [ ] workflow.yaml file loads without YAML syntax errors
+- [ ] instructions.md file exists and is properly formatted
+- [ ] template.md file exists (if document workflow) with valid markdown
+- [ ] All critical headers present in instructions (workflow engine reference, workflow.yaml reference)
+- [ ] Workflow type correctly identified (document/action/interactive/autonomous/meta)
+- [ ] All referenced files actually exist at specified paths
+- [ ] No placeholder text remains (like {TITLE}, {WORKFLOW_CODE}, TODO, etc.)
+
+## Standard Config Block
+
+- [ ] workflow.yaml contains `config_source` pointing to correct module config
+- [ ] `output_folder` pulls from `{config_source}:output_folder`
+- [ ] `user_name` pulls from `{config_source}:user_name`
+- [ ] `communication_language` pulls from `{config_source}:communication_language`
+- [ ] `date` is set to `system-generated`
+- [ ] Config source uses {project-root} variable (not hardcoded path)
+- [ ] Standard config comment present: "Critical variables from config"
+
+## Config Variable Usage
+
+- [ ] Instructions communicate in {communication_language} where appropriate
+- [ ] Instructions address {user_name} in greetings or summaries where appropriate
+- [ ] All file outputs write to {output_folder} or subdirectories (no hardcoded paths)
+- [ ] Template includes {{user_name}} in metadata (optional for document workflows)
+- [ ] Template includes {{date}} in metadata (optional for document workflows)
+- [ ] Template does NOT use {{communication_language}} in headers (agent-only variable)
+- [ ] No hardcoded language-specific text that should use {communication_language}
+- [ ] Date used for agent date awareness (not confused with training cutoff)
+
+## YAML/Instruction/Template Alignment
+
+- [ ] Every workflow.yaml variable (excluding standard config) is used in instructions OR template
+- [ ] No unused yaml fields present (bloat removed)
+- [ ] No duplicate fields between top-level and web_bundle section
+- [ ] All template variables ({{variable}}) have corresponding yaml definitions OR <template-output> tags
+- [ ] All <template-output> tags have corresponding template variables (if document workflow)
+- [ ] Template variables use snake_case naming convention
+- [ ] Variable names are descriptive (not abbreviated like {{puj}} instead of {{primary_user_journey}})
+- [ ] No hardcoded values in instructions that should be yaml variables
+
+## Web Bundle Validation (if applicable)
+
+- [ ] web_bundle section present if workflow needs deployment
+- [ ] All paths in web_bundle use bmad/-relative format (NOT {project-root})
+- [ ] No {config_source} variables in web_bundle section
+- [ ] instructions file listed in web_bundle_files array
+- [ ] template file listed in web_bundle_files (if document workflow)
+- [ ] validation/checklist file listed in web_bundle_files (if exists)
+- [ ] All data files (CSV, JSON, YAML) listed in web_bundle_files
+- [ ] All <invoke-workflow> called workflows have their .yaml files in web_bundle_files
+- [ ] **CRITICAL**: If workflow invokes other workflows, existing_workflows field is present
+- [ ] existing_workflows maps workflow variables to bmad/-relative paths correctly
+- [ ] All files referenced in instructions <action> tags listed in web_bundle_files
+- [ ] No files listed in web_bundle_files that don't exist
+- [ ] Web bundle metadata (name, description, author) matches top-level metadata
+
+## Template Validation (if document workflow)
+
+- [ ] Template variables match <template-output> tags in instructions exactly
+- [ ] All required sections present in template structure
+- [ ] Template uses {{variable}} syntax (double curly braces)
+- [ ] Template variables use snake_case (not camelCase or PascalCase)
+- [ ] Standard metadata header format correct (optional usage of {{date}}, {{user_name}})
+- [ ] No placeholders remain in template (like {SECTION_NAME})
+- [ ] Template structure matches document purpose
+
+## Instructions Quality
+
+- [ ] Each step has n="X" attribute with sequential numbering
+- [ ] Each step has goal="clear goal statement" attribute
+- [ ] Optional steps marked with optional="true"
+- [ ] Repeating steps have appropriate repeat attribute (repeat="3", repeat="for-each-X", repeat="until-approved")
+- [ ] Conditional steps have if="condition" attribute
+- [ ] XML tags used correctly (<action>, <ask>, <check>, <goto>, <invoke-workflow>, <template-output>)
+- [ ] Steps are focused (single goal per step)
+- [ ] Instructions are specific with limits ("Write 1-2 paragraphs" not "Write about")
+- [ ] Examples provided where helpful
+- [ ] <template-output> tags save checkpoints for document workflows
+- [ ] Flow control is logical and clear
+
+## Bloat Detection
+
+- [ ] Bloat percentage under 10% (unused yaml fields / total fields)
+- [ ] No commented-out variables that should be removed
+- [ ] No duplicate metadata between sections
+- [ ] No variables defined but never referenced
+- [ ] No redundant configuration that duplicates web_bundle
+
+## Final Validation
+
+### Critical Issues (Must fix immediately)
+
+_List any critical issues found:_
+
+- Issue 1:
+- Issue 2:
+- Issue 3:
+
+### Important Issues (Should fix soon)
+
+_List any important issues found:_
+
+- Issue 1:
+- Issue 2:
+- Issue 3:
+
+### Cleanup Recommendations (Nice to have)
+
+_List any cleanup recommendations:_
+
+- Recommendation 1:
+- Recommendation 2:
+- Recommendation 3:
+
+---
+
+## Audit Summary
+
+**Total Checks:** 70
+**Passed:** **\_** / 70
+**Failed:** **\_** / 70
+**Pass Rate:** **\_**%
+
+**Recommendation:**
+
+- Pass Rate ≥ 95%: Excellent - Ready for production
+- Pass Rate 85-94%: Good - Minor fixes needed
+- Pass Rate 70-84%: Fair - Important issues to address
+- Pass Rate < 70%: Poor - Significant work required
+
+---
+
+**Audit Completed:** {{date}}
+**Auditor:** Audit Workflow (BMAD v6)

bmad/bmb/workflows/audit-workflow/instructions.md

@@ -0,0 +1,375 @@
+# Audit Workflow - Workflow Quality Audit Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/audit-workflow/workflow.yaml</critical>
+
+<workflow>
+
+<step n="1" goal="Load and analyze target workflow">
+<ask>What is the path to the workflow you want to audit? (provide path to workflow.yaml or workflow folder)</ask>
+
+<action>Load the workflow.yaml file from the provided path</action>
+<action>Identify the workflow type (document, action, interactive, autonomous, meta)</action>
+<action>List all associated files:</action>
+
+- instructions.md (required for most workflows)
+- template.md (if document workflow)
+- checklist.md (if validation exists)
+- Any data files referenced in yaml
+
+<action>Load all discovered files</action>
+
+Display summary:
+
+- Workflow name and description
+- Type of workflow
+- Files present
+- Module assignment
+  </step>
+
+<step n="2" goal="Validate standard config block">
+<action>Check workflow.yaml for the standard config block:</action>
+
+**Required variables:**
+
+- `config_source: "{project-root}/bmad/[module]/config.yaml"`
+- `output_folder: "{config_source}:output_folder"`
+- `user_name: "{config_source}:user_name"`
+- `communication_language: "{config_source}:communication_language"`
+- `date: system-generated`
+
+<action>Validate each variable:</action>
+
+**Config Source Check:**
+
+- [ ] `config_source` is defined
+- [ ] Points to correct module config path
+- [ ] Uses {project-root} variable
+
+**Standard Variables Check:**
+
+- [ ] `output_folder` pulls from config_source
+- [ ] `user_name` pulls from config_source
+- [ ] `communication_language` pulls from config_source
+- [ ] `date` is set to system-generated
+
+<action>Record any missing or incorrect config variables</action>
+<template-output>config_issues</template-output>
+
+<check>If config issues found:</check>
+<action>Add to issues list with severity: CRITICAL</action>
+</step>
+
+<step n="3" goal="Analyze YAML/Instruction/Template alignment">
+<action>Extract all variables defined in workflow.yaml (excluding standard config block)</action>
+<action>Scan instructions.md for variable usage: {variable_name} pattern</action>
+<action>Scan template.md for variable usage: {{variable_name}} pattern (if exists)</action>
+
+<action>Cross-reference analysis:</action>
+
+**For each yaml variable:**
+
+1. Is it used in instructions.md? (mark as INSTRUCTION_USED)
+2. Is it used in template.md? (mark as TEMPLATE_USED)
+3. Is it neither? (mark as UNUSED_BLOAT)
+
+**Special cases to ignore:**
+
+- Standard config variables (config_source, output_folder, user_name, communication_language, date)
+- Workflow metadata (name, description, author)
+- Path variables (installed_path, template, instructions, validation)
+- Web bundle configuration (web_bundle block itself)
+
+<action>Identify unused yaml fields (bloat)</action>
+<action>Identify hardcoded values in instructions that should be variables</action>
+<template-output>alignment_issues</template-output>
+
+<check>If unused variables found:</check>
+<action>Add to issues list with severity: BLOAT</action>
+</step>
+
+<step n="4" goal="Config variable usage audit">
+<action>Analyze instructions.md for proper config variable usage:</action>
+
+**Communication Language Check:**
+
+- Search for phrases like "communicate in {communication_language}"
+- Check if greetings/responses use language-aware patterns
+- Verify NO usage of {{communication_language}} in template headers
+
+**User Name Check:**
+
+- Look for user addressing patterns using {user_name}
+- Check if summaries or greetings personalize with {user_name}
+- Verify optional usage in template metadata (not required)
+
+**Output Folder Check:**
+
+- Search for file write operations
+- Verify all outputs go to {output_folder} or subdirectories
+- Check for hardcoded paths like "/output/" or "/generated/"
+
+**Date Usage Check:**
+
+- Verify date is available for agent date awareness
+- Check optional usage in template metadata
+- Ensure no confusion between date and model training cutoff
+
+<action>Record any improper config variable usage</action>
+<template-output>config_usage_issues</template-output>
+
+<check>If config usage issues found:</check>
+<action>Add to issues list with severity: IMPORTANT</action>
+</step>
+
+<step n="5" goal="Web bundle validation" optional="true">
+<check>If workflow.yaml contains web_bundle section:</check>
+
+<action>Validate web_bundle structure:</action>
+
+**Path Validation:**
+
+- [ ] All paths use bmad/-relative format (NOT {project-root})
+- [ ] No {config_source} variables in web_bundle section
+- [ ] Paths match actual file locations
+
+**Completeness Check:**
+
+- [ ] instructions file listed in web_bundle_files
+- [ ] template file listed (if document workflow)
+- [ ] validation/checklist file listed (if exists)
+- [ ] All data files referenced in yaml listed
+- [ ] All files referenced in instructions listed
+
+**Workflow Dependency Scan:**
+<action>Scan instructions.md for <invoke-workflow> tags</action>
+<action>Extract workflow paths from invocations</action>
+<action>Verify each called workflow.yaml is in web_bundle_files</action>
+<action>**CRITICAL**: Check if existing_workflows field is present when workflows are invoked</action>
+<action>If <invoke-workflow> calls exist, existing_workflows MUST map workflow variables to paths</action>
+<action>Example: If instructions use {core_brainstorming}, web_bundle needs:
+existing_workflows: - core_brainstorming: "bmad/core/workflows/brainstorming/workflow.yaml"
+</action>
+
+**File Reference Scan:**
+<action>Scan instructions.md for file references in <action> tags</action>
+<action>Check for CSV, JSON, YAML, MD files referenced</action>
+<action>Verify all referenced files are in web_bundle_files</action>
+
+<action>Record any missing files or incorrect paths</action>
+<template-output>web_bundle_issues</template-output>
+
+<check>If web_bundle issues found:</check>
+<action>Add to issues list with severity: CRITICAL</action>
+
+<check>If no web_bundle section exists:</check>
+<action>Note: "No web_bundle configured (may be intentional for local-only workflows)"</action>
+</step>
+
+<step n="6" goal="Bloat detection">
+<action>Identify bloat patterns:</action>
+
+**Unused YAML Fields:**
+
+- Variables defined but not used in instructions OR template
+- Duplicate fields between top-level and web_bundle section
+- Commented-out variables that should be removed
+
+**Hardcoded Values:**
+
+- File paths that should use {output_folder}
+- Generic greetings that should use {user_name}
+- Language-specific text that should use {communication_language}
+- Static dates that should use {date}
+
+**Redundant Configuration:**
+
+- Variables that duplicate web_bundle fields
+- Metadata repeated across sections
+
+<action>Calculate bloat metrics:</action>
+
+- Total yaml fields: {{total_yaml_fields}}
+- Used fields: {{used_fields}}
+- Unused fields: {{unused_fields}}
+- Bloat percentage: {{bloat_percentage}}%
+
+<action>Record all bloat items with recommendations</action>
+<template-output>bloat_items</template-output>
+
+<check>If bloat detected:</check>
+<action>Add to issues list with severity: CLEANUP</action>
+</step>
+
+<step n="7" goal="Template variable mapping" if="workflow_type == 'document'">
+<action>Extract all template variables from template.md: {{variable_name}} pattern</action>
+<action>Scan instructions.md for corresponding <template-output>variable_name</template-output> tags</action>
+
+<action>Cross-reference mapping:</action>
+
+**For each template variable:**
+
+1. Is there a matching <template-output> tag? (mark as MAPPED)
+2. Is it a standard config variable? (mark as CONFIG_VAR - optional)
+3. Is it unmapped? (mark as MISSING_OUTPUT)
+
+**For each <template-output> tag:**
+
+1. Is there a matching template variable? (mark as USED)
+2. Is it orphaned? (mark as UNUSED_OUTPUT)
+
+<action>Verify variable naming conventions:</action>
+
+- [ ] All template variables use snake_case
+- [ ] Variable names are descriptive (not abbreviated)
+- [ ] Standard config variables properly formatted
+
+<action>Record any mapping issues</action>
+<template-output>template_issues</template-output>
+
+<check>If template issues found:</check>
+<action>Add to issues list with severity: IMPORTANT</action>
+</step>
+
+<step n="8" goal="Generate comprehensive audit report">
+<action>Compile all findings into a structured report</action>
+
+<action>Write audit report to {output_folder}/audit-report-{{workflow_name}}-{{date}}.md</action>
+
+**Report Structure:**
+
+```markdown
+# Workflow Audit Report
+
+**Workflow:** {{workflow_name}}
+**Audit Date:** {{date}}
+**Auditor:** Audit Workflow (BMAD v6)
+**Workflow Type:** {{workflow_type}}
+
+---
+
+## Executive Summary
+
+**Overall Status:** {{overall_status}}
+
+- Critical Issues: {{critical_count}}
+- Important Issues: {{important_count}}
+- Cleanup Recommendations: {{cleanup_count}}
+
+---
+
+## 1. Standard Config Block Validation
+
+{{config_issues}}
+
+**Status:** {{config_status}}
+
+---
+
+## 2. YAML/Instruction/Template Alignment
+
+{{alignment_issues}}
+
+**Variables Analyzed:** {{total_variables}}
+**Used in Instructions:** {{instruction_usage_count}}
+**Used in Template:** {{template_usage_count}}
+**Unused (Bloat):** {{bloat_count}}
+
+---
+
+## 3. Config Variable Usage
+
+{{config_usage_issues}}
+
+**Communication Language:** {{comm_lang_status}}
+**User Name:** {{user_name_status}}
+**Output Folder:** {{output_folder_status}}
+**Date:** {{date_status}}
+
+---
+
+## 4. Web Bundle Validation
+
+{{web_bundle_issues}}
+
+**Web Bundle Present:** {{web_bundle_exists}}
+**Files Listed:** {{web_bundle_file_count}}
+**Missing Files:** {{missing_files_count}}
+
+---
+
+## 5. Bloat Detection
+
+{{bloat_items}}
+
+**Bloat Percentage:** {{bloat_percentage}}%
+**Cleanup Potential:** {{cleanup_potential}}
+
+---
+
+## 6. Template Variable Mapping
+
+{{template_issues}}
+
+**Template Variables:** {{template_var_count}}
+**Mapped Correctly:** {{mapped_count}}
+**Missing Mappings:** {{missing_mapping_count}}
+
+---
+
+## Recommendations
+
+### Critical (Fix Immediately)
+
+{{critical_recommendations}}
+
+### Important (Address Soon)
+
+{{important_recommendations}}
+
+### Cleanup (Nice to Have)
+
+{{cleanup_recommendations}}
+
+---
+
+## Validation Checklist
+
+Use this checklist to verify fixes:
+
+- [ ] All standard config variables present and correct
+- [ ] No unused yaml fields (bloat removed)
+- [ ] Config variables used appropriately in instructions
+- [ ] Web bundle includes all dependencies
+- [ ] Template variables properly mapped
+- [ ] File structure follows v6 conventions
+
+---
+
+## Next Steps
+
+1. Review critical issues and fix immediately
+2. Address important issues in next iteration
+3. Consider cleanup recommendations for optimization
+4. Re-run audit after fixes to verify improvements
+
+---
+
+**Audit Complete** - Generated by audit-workflow v1.0
+```
+
+<action>Display summary to {user_name} in {communication_language}</action>
+<action>Provide path to full audit report</action>
+
+<ask>Would you like to:
+
+- View the full audit report
+- Fix issues automatically (invoke edit-workflow)
+- Audit another workflow
+- Exit
+  </ask>
+
+<template-output>audit_report_path</template-output>
+</step>
+
+</workflow>

bmad/bmb/workflows/audit-workflow/workflow.yaml

@@ -0,0 +1,21 @@
+# Audit Workflow Configuration
+name: "audit-workflow"
+description: "Comprehensive workflow quality audit - validates structure, config standards, variable usage, bloat detection, and web_bundle completeness. Performs deep analysis of workflow.yaml, instructions.md, template.md, and web_bundle configuration against BMAD v6 standards."
+author: "BMad"
+
+# Critical variables from config
+config_source: "{project-root}/bmad/bmb/config.yaml"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+date: system-generated
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/audit-workflow"
+template: false
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Output configuration
+default_output_file: "{output_folder}/audit-report-{{workflow_name}}-{{date}}.md"
+# Web bundle configuration

bmad/bmb/workflows/convert-legacy/README.md

@@ -0,0 +1,262 @@
+# Convert Legacy Workflow
+
+## Overview
+
+The Convert Legacy workflow is a comprehensive migration tool that converts BMAD v4 items (agents, workflows, modules) to v5 compliant format with proper structure and conventions. It bridges the gap between legacy BMAD implementations and the modern v5 architecture, ensuring seamless migration while preserving functionality and improving structure.
+
+## Key Features
+
+- **Multi-Format Detection** - Automatically identifies v4 agents, workflows, tasks, templates, and modules
+- **Intelligent Conversion** - Smart mapping from v4 patterns to v5 equivalents with structural improvements
+- **Sub-Workflow Integration** - Leverages create-agent, create-workflow, and create-module workflows for quality output
+- **Structure Modernization** - Converts YAML-based agents to XML, templates to workflows, tasks to structured workflows
+- **Path Normalization** - Updates all references to use proper v5 path conventions
+- **Validation System** - Comprehensive validation of converted items before finalization
+- **Migration Reporting** - Detailed conversion reports with locations and manual adjustment notes
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow convert-legacy
+```
+
+### With Legacy File Input
+
+```bash
+# Convert a specific v4 item
+workflow convert-legacy --input /path/to/legacy-agent.md
+```
+
+### With Legacy Module
+
+```bash
+# Convert an entire v4 module structure
+workflow convert-legacy --input /path/to/legacy-module/
+```
+
+### Configuration
+
+The workflow uses standard BMB configuration:
+
+- **output_folder**: Where converted items will be placed
+- **user_name**: Author information for converted items
+- **conversion_mappings**: v4-to-v5 pattern mappings (optional)
+
+## Workflow Structure
+
+### Files Included
+
+```
+convert-legacy/
+├── workflow.yaml           # Configuration and metadata
+├── instructions.md         # Step-by-step conversion guide
+├── checklist.md           # Validation criteria
+└── README.md              # This file
+```
+
+## Workflow Process
+
+### Phase 1: Legacy Analysis (Steps 1-3)
+
+**Item Identification and Loading**
+
+- Accepts file path or directory from user
+- Loads complete file/folder structure for analysis
+- Automatically detects item type based on content patterns:
+  - **Agents**: Contains `<agent>` or `<prompt>` XML tags
+  - **Workflows**: Contains workflow YAML or instruction patterns
+  - **Modules**: Contains multiple organized agents/workflows
+  - **Tasks**: Contains `<task>` XML tags
+  - **Templates**: Contains YAML-based document generators
+
+**Legacy Structure Analysis**
+
+- Parses v4 structure and extracts key components
+- Maps v4 agent metadata (name, id, title, icon, persona)
+- Analyzes v4 template sections and elicitation patterns
+- Identifies task workflows and decision trees
+- Catalogs dependencies and file references
+
+**Target Module Selection**
+
+- Prompts for target module (bmm, bmb, cis, custom)
+- Determines proper installation paths using v5 conventions
+- Shows target location for user confirmation
+- Ensures all paths use `{project-root}/bmad/` format
+
+### Phase 2: Conversion Strategy (Step 4)
+
+**Strategy Selection Based on Item Type**
+
+- **Simple Agents**: Direct XML conversion with metadata mapping
+- **Complex Agents**: Workflow-assisted creation using create-agent
+- **Templates**: Template-to-workflow conversion with proper structure
+- **Tasks**: Task-to-workflow conversion with step mapping
+- **Modules**: Full module creation using create-module workflow
+
+**Workflow Type Determination**
+
+- Analyzes legacy items to determine v5 workflow type:
+  - **Document Workflow**: Generates documents with templates
+  - **Action Workflow**: Performs actions without output documents
+  - **Interactive Workflow**: Guides user interaction sessions
+  - **Meta-Workflow**: Coordinates other workflows
+
+### Phase 3: Conversion Execution (Steps 5a-5e)
+
+**Direct Agent Conversion (5a)**
+
+- Transforms v4 YAML agent format to v5 XML structure
+- Maps persona blocks (role, style, identity, principles)
+- Converts commands list to v5 `<cmds>` format
+- Updates task references to workflow invocations
+- Normalizes all paths to v5 conventions
+
+**Workflow-Assisted Creation (5b-5e)**
+
+- Extracts key information from legacy items
+- Invokes appropriate sub-workflows:
+  - `create-agent` for complex agent creation
+  - `create-workflow` for template/task conversion
+  - `create-module` for full module migration
+- Ensures proper v5 structure and conventions
+
+**Template-to-Workflow Conversion (5c)**
+
+- Converts YAML template sections to workflow steps
+- Maps `elicit: true` flags to `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` tags
+- Transforms conditional sections to flow control
+- Creates proper template.md from content structure
+- Integrates v4 create-doc.md task patterns
+
+**Task-to-Workflow Conversion (5e)**
+
+- Analyzes task purpose to determine workflow type
+- Extracts step-by-step instructions to workflow steps
+- Converts decision trees to flow control tags
+- Maps 1-9 elicitation menus to v5 elicitation patterns
+- Preserves execution logic and critical notices
+
+### Phase 4: Validation and Finalization (Steps 6-8)
+
+**Comprehensive Validation**
+
+- Validates XML structure for agents
+- Checks YAML syntax for workflows
+- Verifies template variable consistency
+- Ensures proper file structure and naming
+
+**Migration Reporting**
+
+- Generates detailed conversion report
+- Documents original and new locations
+- Notes manual adjustments needed
+- Provides warnings and recommendations
+
+**Cleanup and Archival**
+
+- Optional archival of original v4 files
+- Final location confirmation
+- Post-conversion instructions and next steps
+
+## Output
+
+### Generated Files
+
+- **Converted Items**: Proper v5 format in target module locations
+- **Migration Report**: Detailed conversion documentation
+- **Validation Results**: Quality assurance confirmation
+
+### Output Structure
+
+Converted items follow v5 conventions:
+
+1. **Agents** - XML format with proper persona and command structure
+2. **Workflows** - Complete workflow folders with yaml, instructions, and templates
+3. **Modules** - Full module structure with installation infrastructure
+4. **Documentation** - Updated paths, references, and metadata
+
+## Requirements
+
+- **Legacy v4 Items** - Source files or directories to convert
+- **Target Module Access** - Write permissions to target module directories
+- **Sub-Workflow Availability** - create-agent, create-workflow, create-module workflows accessible
+- **Conversion Mappings** (optional) - v4-to-v5 pattern mappings for complex conversions
+
+## Best Practices
+
+### Before Starting
+
+1. **Backup Legacy Items** - Create copies of original v4 files before conversion
+2. **Review Target Module** - Understand target module structure and conventions
+3. **Plan Module Organization** - Decide where converted items should logically fit
+
+### During Execution
+
+1. **Validate Item Type Detection** - Confirm automatic detection or correct manually
+2. **Choose Appropriate Strategy** - Use workflow-assisted creation for complex items
+3. **Review Path Mappings** - Ensure all references use proper v5 path conventions
+4. **Test Incrementally** - Convert simple items first to validate process
+
+### After Completion
+
+1. **Validate Converted Items** - Test agents and workflows for proper functionality
+2. **Review Migration Report** - Address any manual adjustments noted
+3. **Update Documentation** - Ensure README and documentation reflect changes
+4. **Archive Originals** - Store v4 files safely for reference if needed
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: Item type detection fails or incorrect
+
+- **Solution**: Manually specify item type when prompted
+- **Check**: Verify file structure matches expected v4 patterns
+
+**Issue**: Path conversion errors
+
+- **Solution**: Ensure all references use `{project-root}/bmad/` format
+- **Check**: Review conversion mappings for proper path patterns
+
+**Issue**: Sub-workflow invocation fails
+
+- **Solution**: Verify build workflows are available and accessible
+- **Check**: Ensure target module exists and has proper permissions
+
+**Issue**: XML or YAML syntax errors in output
+
+- **Solution**: Review conversion mappings and adjust patterns
+- **Check**: Validate converted files with appropriate parsers
+
+## Customization
+
+To customize this workflow:
+
+1. **Update Conversion Mappings** - Modify v4-to-v5 pattern mappings in data/
+2. **Extend Detection Logic** - Add new item type detection patterns
+3. **Add Conversion Strategies** - Implement specialized conversion approaches
+4. **Enhance Validation** - Add additional quality checks in validation step
+
+## Version History
+
+- **v1.0.0** - Initial release
+  - Multi-format v4 item detection and conversion
+  - Integration with create-agent, create-workflow, create-module
+  - Comprehensive path normalization
+  - Migration reporting and validation
+
+## Support
+
+For issues or questions:
+
+- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Check conversion mappings at `/bmad/bmb/data/v4-to-v5-mappings.yaml`
+- Validate output using `checklist.md`
+- Consult BMAD v5 documentation for proper conventions
+
+---
+
+_Part of the BMad Method v5 - BMB (Builder) Module_

bmad/bmb/workflows/convert-legacy/checklist.md

@@ -0,0 +1,205 @@
+# Convert Legacy - Validation Checklist
+
+## Pre-Conversion Validation
+
+### Source Analysis
+
+- [ ] Original v4 file(s) fully loaded and parsed
+- [ ] Item type correctly identified (agent/template/task/module)
+- [ ] All dependencies documented and accounted for
+- [ ] No critical content overlooked in source files
+
+## Conversion Completeness
+
+### For Agent Conversions
+
+#### Content Preservation
+
+- [ ] Agent name, id, title, and icon transferred
+- [ ] All persona elements mapped to v5 structure
+- [ ] All commands converted to v5 menu array (YAML)
+- [ ] Dependencies properly referenced or converted
+- [ ] Activation instructions adapted to v5 patterns
+
+#### v5 Compliance (YAML Format)
+
+- [ ] Valid YAML structure with proper indentation
+- [ ] agent.metadata has all required fields (id, name, title, icon, module)
+- [ ] agent.persona has all sections (role, identity, communication_style, principles)
+- [ ] agent.menu uses proper handlers (workflow, action, exec, tmpl, data)
+- [ ] agent.critical_actions array present when needed
+- [ ] agent.prompts defined for any action: "#id" references
+- [ ] File extension is .agent.yaml (will be compiled to .md later)
+
+#### Best Practices
+
+- [ ] Commands use appropriate workflow references instead of direct task calls
+- [ ] File paths use {project-root} variables
+- [ ] Config values use {config_source}: pattern
+- [ ] Agent follows naming conventions (kebab-case for files)
+- [ ] ALL paths reference {project-root}/bmad/{{module}}/ locations, NOT src/
+- [ ] exec, data, run-workflow commands point to final BMAD installation paths
+
+### For Template/Workflow Conversions
+
+#### Content Preservation
+
+- [ ] Template metadata (name, description, output) transferred
+- [ ] All sections converted to workflow steps
+- [ ] Section hierarchy maintained in instructions
+- [ ] Variables ({{var}}) preserved in template.md
+- [ ] Elicitation points (elicit: true) converted to <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
+- [ ] Conditional sections preserved with if="" attributes
+- [ ] Repeatable sections converted to repeat="" attributes
+
+#### v5 Compliance
+
+- [ ] workflow.yaml follows structure from workflow-creation-guide.md
+- [ ] instructions.md has critical headers referencing workflow engine
+- [ ] Steps numbered sequentially with clear goals
+- [ ] Template variables match between instructions and template.md
+- [ ] Proper use of XML tags (<action>, <check>, <ask>, <template-output>)
+- [ ] File structure follows v5 pattern (folder with yaml/md files)
+
+#### Best Practices
+
+- [ ] Steps are focused with single goals
+- [ ] Instructions are specific ("Write 1-2 paragraphs" not "Write about")
+- [ ] Examples provided where helpful
+- [ ] Limits set where appropriate ("3-5 items maximum")
+- [ ] Save checkpoints with <template-output> at logical points
+- [ ] Variables use descriptive snake_case names
+
+### For Task Conversions
+
+#### Content Preservation
+
+- [ ] Task logic fully captured in workflow instructions
+- [ ] Execution flow maintained
+- [ ] User interaction points preserved
+- [ ] Decision trees converted to workflow logic
+- [ ] All processing steps accounted for
+- [ ] Document generation patterns identified and preserved
+
+#### Type Determination
+
+- [ ] Workflow type correctly identified (document/action/interactive/meta)
+- [ ] If generates documents, template.md created
+- [ ] If performs actions only, marked as action workflow
+- [ ] Output patterns properly analyzed
+
+#### v5 Compliance
+
+- [ ] Converted to proper workflow format (not standalone task)
+- [ ] Follows workflow execution engine patterns
+- [ ] Interactive elements use proper v5 tags
+- [ ] Flow control uses v5 patterns (goto, check, loop)
+- [ ] 1-9 elicitation menus converted to v5 elicitation
+- [ ] Critical notices preserved in workflow.yaml
+- [ ] YOLO mode converted to appropriate v5 patterns
+
+### Module-Level Validation
+
+#### Structure
+
+- [ ] Module follows v5 directory structure
+- [ ] All components in correct locations:
+  - Agents in /agents/
+  - Workflows in /workflows/
+  - Data files in appropriate locations
+- [ ] Config files properly formatted
+
+#### Integration
+
+- [ ] Cross-references between components work
+- [ ] Workflow invocations use correct paths
+- [ ] Data file references are valid
+- [ ] No broken dependencies
+
+## Technical Validation
+
+### Syntax and Format
+
+- [ ] YAML files have valid syntax (no parsing errors)
+- [ ] XML structures properly formed and closed
+- [ ] Markdown files render correctly
+- [ ] File encoding is UTF-8
+- [ ] Line endings consistent (LF)
+
+### Path Resolution
+
+- [ ] All file paths resolve correctly
+- [ ] Variable substitutions work ({project-root}, {installed_path}, etc.)
+- [ ] Config references load properly
+- [ ] No hardcoded absolute paths (unless intentional)
+
+## Functional Validation
+
+### Execution Testing
+
+- [ ] Converted item can be loaded without errors
+- [ ] Agents activate properly when invoked
+- [ ] Workflows execute through completion
+- [ ] User interaction points function correctly
+- [ ] Output generation works as expected
+
+### Behavioral Validation
+
+- [ ] Converted item behaves similarly to v4 version
+- [ ] Core functionality preserved
+- [ ] User experience maintains or improves
+- [ ] No functionality regression
+
+## Documentation and Cleanup
+
+### Documentation
+
+- [ ] Conversion report generated with all changes
+- [ ] Any manual adjustments documented
+- [ ] Known limitations or differences noted
+- [ ] Migration instructions provided if needed
+
+### Post-Conversion
+
+- [ ] Original v4 files archived (if requested)
+- [ ] File permissions set correctly
+- [ ] Git tracking updated if applicable
+- [ ] User informed of new locations
+
+## Final Verification
+
+### Quality Assurance
+
+- [ ] Converted item follows ALL v5 best practices
+- [ ] Code/config is clean and maintainable
+- [ ] No TODO or FIXME items remain
+- [ ] Ready for production use
+
+### User Acceptance
+
+- [ ] User reviewed conversion output
+- [ ] User tested basic functionality
+- [ ] User approved final result
+- [ ] Any user feedback incorporated
+
+## Notes Section
+
+### Conversion Issues Found:
+
+_List any issues encountered during validation_
+
+### Manual Interventions Required:
+
+_Document any manual fixes needed_
+
+### Recommendations:
+
+_Suggestions for further improvements or considerations_
+
+---
+
+**Validation Result:** [ ] PASSED / [ ] FAILED
+
+**Validator:** {{user_name}}
+**Date:** {{date}}
+**Items Converted:** {{conversion_summary}}

bmad/bmb/workflows/convert-legacy/instructions.md

@@ -0,0 +1,374 @@
+# Convert Legacy - v4 to v5 Conversion Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<parameter name="You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml</critical>
+<critical>Communicate in {communication_language} throughout the conversion process</critical>
+
+<workflow>
+
+<step n="1" goal="Identify and Load Legacy Item">
+<action>Ask user for the path to the v4 item to convert (agent, workflow, or module)</action>
+<action>Load the complete file/folder structure</action>
+<action>Detect item type based on structure and content patterns:</action>
+  - Agent: Contains agent or prompt XML tags, single file
+  - Workflow: Contains workflow YAML or instruction patterns, usually folder
+  - Module: Contains multiple agents/workflows in organized structure
+  - Task: Contains task XML tags
+<ask>Confirm detected type or allow user to correct: "Detected as [type]. Is this correct? (y/n)"</ask>
+</step>
+
+<step n="2" goal="Analyze Legacy Structure">
+<action>Parse the v4 structure and extract key components:</action>
+
+For v4 Agents (YAML-based in markdown):
+
+- Agent metadata (name, id, title, icon, whenToUse)
+- Persona block (role, style, identity, focus, core_principles)
+- Commands list with task/template references
+- Dependencies (tasks, templates, checklists, data files)
+- Activation instructions and workflow rules
+- IDE file resolution patterns
+
+For v4 Templates (YAML-based document generators):
+
+- Template metadata (id, name, version, output)
+- Workflow mode and elicitation settings
+- Sections hierarchy with:
+  - Instructions for content generation
+  - Elicit flags for user interaction
+  - Templates with {{variables}}
+  - Conditional sections
+  - Repeatable sections
+
+For v4 Tasks (Markdown with execution instructions):
+
+- Critical execution notices
+- Step-by-step workflows
+- Elicitation requirements (1-9 menu format)
+- Processing flows and decision trees
+- Agent permission rules
+
+For Modules:
+
+- Module metadata
+- Component list (agents, workflows, tasks)
+- Dependencies
+- Installation requirements
+
+<action>Create a conversion map of what needs to be transformed</action>
+<action>Map v4 patterns to v5 equivalents:
+
+- v4 Task + Template → v5 Workflow (folder with workflow.yaml, instructions.md, template.md)
+- v4 Agent YAML → v5 Agent YAML format
+- v4 Commands → v5 <menu> with proper handlers
+- v4 Dependencies → v5 workflow references or data files
+  </action>
+  </step>
+
+<step n="3" goal="Determine Target Module and Location">
+<ask>Which module should this belong to? (eg. bmm, bmb, cis, bmm-legacy, or custom)</ask>
+<check>If custom module:</check>
+  <ask>Enter custom module code (kebab-case):</ask>
+<action>Determine installation path based on type and module</action>
+<critical>IMPORTANT: All paths must use final BMAD installation locations, not src paths!</critical>
+<action>Show user the target location: {project-root}/bmad/{{target_module}}/{{item_type}}/{{item_name}}</action>
+<action>Note: Files will be created in bmad/ but all internal paths will reference {project-root}/bmad/ locations</action>
+<ask>Proceed with this location? (y/n)</ask>
+</step>
+
+<step n="4" goal="Choose Conversion Strategy">
+<action>Based on item type and complexity, choose approach:</action>
+
+<check>If agent conversion:</check>
+<check>If simple agent (basic persona + commands):</check>
+<action>Use direct conversion to v5 agent YAML format</action>
+<goto step="5a">Direct Agent Conversion</goto>
+<check>If complex agent with embedded workflows:</check>
+<action>Plan to invoke create-agent workflow</action>
+<goto step="5b">Workflow-Assisted Agent Creation</goto>
+
+<check>If template or task conversion to workflow:</check>
+<action>Analyze the v4 item to determine workflow type:</action>
+
+- Does it generate a specific document type? → Document workflow
+- Does it produce structured output files? → Document workflow
+- Does it perform actions without output? → Action workflow
+- Does it coordinate other tasks? → Meta-workflow
+- Does it guide user interaction? → Interactive workflow
+
+<ask>Based on analysis, this appears to be a {{detected_workflow_type}} workflow. Confirm or correct:
+
+1. Document workflow (generates documents with template)
+2. Action workflow (performs actions, no template)
+3. Interactive workflow (guided session)
+4. Meta-workflow (coordinates other workflows)
+   Select 1-4:</ask>
+
+<check>If template conversion:</check>
+<goto step="5c">Template-to-Workflow Conversion</goto>
+<check>If task conversion:</check>
+<goto step="5e">Task-to-Workflow Conversion</goto>
+
+<check>If full module conversion:</check>
+<action>Plan to invoke create-module workflow</action>
+<goto step="5d">Module Creation</goto>
+</step>
+
+<step n="5a" goal="Direct Agent Conversion" optional="true">
+<action>Transform v4 YAML agent to v5 YAML format:</action>
+
+1. Convert agent metadata structure:
+   - v4 `agent.name` → v5 `agent.metadata.name`
+   - v4 `agent.id` → v5 `agent.metadata.id`
+   - v4 `agent.title` → v5 `agent.metadata.title`
+   - v4 `agent.icon` → v5 `agent.metadata.icon`
+   - Add v5 `agent.metadata.module` field
+
+2. Transform persona structure:
+   - v4 `persona.role` → v5 `agent.persona.role` (keep as YAML string)
+   - v4 `persona.style` → v5 `agent.persona.communication_style`
+   - v4 `persona.identity` → v5 `agent.persona.identity`
+   - v4 `persona.core_principles` → v5 `agent.persona.principles` (as array)
+
+3. Convert commands to menu:
+   - v4 `commands:` list → v5 `agent.menu:` array
+   - Each command becomes menu item with:
+     - `trigger:` (without \* prefix - added at build)
+     - `description:`
+     - Handler attributes (`workflow:`, `exec:`, `action:`, etc.)
+   - Map task references to workflow paths
+   - Map template references to workflow invocations
+
+4. Add v5-specific sections (in YAML):
+   - `agent.prompts:` array for inline prompts (if using action: "#id")
+   - `agent.critical_actions:` array for startup requirements
+   - `agent.activation_rules:` for universal agent rules
+
+5. Handle dependencies and paths:
+   - Convert task dependencies to workflow references
+   - Map template dependencies to v5 workflows
+   - Preserve checklist and data file references
+   - CRITICAL: All paths must use {project-root}/bmad/{{module}}/ NOT src/
+
+<action>Generate the converted v5 agent YAML file (.agent.yaml)</action>
+<action>Example path conversions:
+
+- exec="{project-root}/bmad/{{target_module}}/tasks/task-name.md"
+- run-workflow="{project-root}/bmad/{{target_module}}/workflows/workflow-name/workflow.yaml"
+- data="{project-root}/bmad/{{target_module}}/data/data-file.yaml"
+  </action>
+  <action>Save to: bmad/{{target_module}}/agents/{{agent_name}}.agent.yaml (physical location)</action>
+  <action>Note: The build process will later compile this to .md with XML format</action>
+  <goto step="6">Continue to Validation</goto>
+  </step>
+
+<step n="5b" goal="Workflow-Assisted Agent Creation" optional="true">
+<action>Extract key information from v4 agent:</action>
+- Name and purpose
+- Commands and functionality
+- Persona traits
+- Any special behaviors
+
+<invoke-workflow>
+  workflow: {project-root}/bmad/bmb/workflows/create-agent/workflow.yaml
+  inputs:
+    - agent_name: {{extracted_name}}
+    - agent_purpose: {{extracted_purpose}}
+    - commands: {{extracted_commands}}
+    - persona: {{extracted_persona}}
+</invoke-workflow>
+
+<goto step="6">Continue to Validation</goto>
+</step>
+
+<step n="5c" goal="Template-to-Workflow Conversion" optional="true">
+<action>Convert v4 Template (YAML) to v5 Workflow:</action>
+
+1. Extract template metadata:
+   - Template id, name, version → workflow.yaml name/description
+   - Output settings → default_output_file
+   - Workflow mode (interactive/yolo) → workflow settings
+
+2. Convert template sections to instructions.md:
+   - Each YAML section → workflow step
+   - `elicit: true` → `<invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>` tag
+   - Conditional sections → `if="condition"` attribute
+   - Repeatable sections → `repeat="for-each"` attribute
+   - Section instructions → step content
+
+3. Extract template structure to template.md:
+   - Section content fields → template structure
+   - {{variables}} → preserve as-is
+   - Nested sections → hierarchical markdown
+
+4. Handle v4 create-doc.md task integration:
+   - Elicitation methods (1-9 menu) → convert to v5 elicitation
+   - Agent permissions → note in instructions
+   - Processing flow → integrate into workflow steps
+
+<critical>When invoking create-workflow, the standard config block will be automatically added:</critical>
+
+```yaml
+# Critical variables from config
+config_source: '{project-root}/bmad/{{target_module}}/config.yaml'
+output_folder: '{config_source}:output_folder'
+user_name: '{config_source}:user_name'
+communication_language: '{config_source}:communication_language'
+date: system-generated
+```
+
+<invoke-workflow>
+  workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
+  inputs:
+    - workflow_name: {{template_name}}
+    - workflow_type: document
+    - template_structure: {{extracted_template}}
+    - instructions: {{converted_sections}}
+</invoke-workflow>
+
+<action>Verify the created workflow.yaml includes standard config block</action>
+<action>Update converted instructions to use config variables where appropriate</action>
+
+<goto step="6">Continue to Validation</goto>
+</step>
+
+<step n="5d" goal="Module Creation" optional="true">
+<action>Analyze module structure and components</action>
+<action>Create module blueprint with all components</action>
+
+<invoke-workflow>
+  workflow: {project-root}/bmad/bmb/workflows/create-module/workflow.yaml
+  inputs:
+    - module_name: {{module_name}}
+    - components: {{component_list}}
+</invoke-workflow>
+
+<goto step="6">Continue to Validation</goto>
+</step>
+
+<step n="5e" goal="Task-to-Workflow Conversion" optional="true">
+<action>Convert v4 Task (Markdown) to v5 Workflow:</action>
+
+1. Analyze task purpose and output:
+   - Does it generate documents? → Create template.md
+   - Does it process data? → Action workflow
+   - Does it guide user interaction? → Interactive workflow
+   - Check for file outputs, templates, or document generation
+
+2. Extract task components:
+   - Execution notices and critical rules → workflow.yaml metadata
+   - Step-by-step instructions → instructions.md steps
+   - Decision trees and branching → flow control tags
+   - User interaction patterns → appropriate v5 tags
+
+3. Based on confirmed workflow type:
+   <check>If Document workflow:</check>
+   - Create template.md from output patterns
+   - Map generation steps to instructions
+   - Add <template-output> tags for sections
+
+   <check>If Action workflow:</check>
+   - Set template: false in workflow.yaml
+   - Focus on action sequences in instructions
+   - Preserve execution logic
+
+4. Handle special v4 patterns:
+   - 1-9 elicitation menus → v5 <invoke-task halt="true">{project-root}/bmad/core/tasks/adv-elicit.xml</invoke-task>
+   - Agent permissions → note in instructions
+   - YOLO mode → autonomous flag or optional steps
+   - Critical notices → workflow.yaml comments
+
+<critical>When invoking create-workflow, the standard config block will be automatically added:</critical>
+
+```yaml
+# Critical variables from config
+config_source: '{project-root}/bmad/{{target_module}}/config.yaml'
+output_folder: '{config_source}:output_folder'
+user_name: '{config_source}:user_name'
+communication_language: '{config_source}:communication_language'
+date: system-generated
+```
+
+<invoke-workflow>
+  workflow: {project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml
+  inputs:
+    - workflow_name: {{task_name}}
+    - workflow_type: {{confirmed_workflow_type}}
+    - instructions: {{extracted_task_logic}}
+    - template: {{generated_template_if_document}}
+</invoke-workflow>
+
+<action>Verify the created workflow.yaml includes standard config block</action>
+<action>Update converted instructions to use config variables where appropriate</action>
+
+<goto step="6">Continue to Validation</goto>
+</step>
+
+<step n="6" goal="Validate Conversion">
+<action>Run validation checks on converted item:</action>
+
+For Agents:
+
+- [ ] Valid YAML structure (.agent.yaml)
+- [ ] All required sections present (metadata, persona, menu)
+- [ ] Menu items properly formatted (trigger, description, handlers)
+- [ ] Paths use {project-root} variables
+
+For Workflows:
+
+- [ ] Valid YAML syntax
+- [ ] Instructions follow v5 conventions
+- [ ] Template variables match
+- [ ] File structure correct
+
+**Standard Config Validation (Workflows):**
+
+- [ ] workflow.yaml contains standard config block:
+  - config_source defined
+  - output_folder, user_name, communication_language pulled from config
+  - date set to system-generated
+- [ ] Converted instructions use config variables where appropriate
+- [ ] Template includes config variables in metadata (if document workflow)
+- [ ] No hardcoded paths that should use {output_folder}
+- [ ] No generic greetings that should use {user_name}
+
+For Modules:
+
+- [ ] All components converted
+- [ ] Proper folder structure
+- [ ] Config files valid
+- [ ] Installation ready
+
+<action>Show validation results to user</action>
+<ask>Any issues to fix before finalizing? (y/n)</ask>
+<check>If yes:</check>
+<action>Address specific issues</action>
+<goto step="6">Re-validate</goto>
+</step>
+
+<step n="7" goal="Migration Report">
+<action>Generate conversion report showing:</action>
+- Original v4 location
+- New v5 location
+- Items converted
+- Any manual adjustments needed
+- Warnings or notes
+
+<action>Save report to: {output_folder}/conversion-report-{{date}}.md</action>
+<action>Inform {user_name} in {communication_language} that the conversion report has been generated</action>
+</step>
+
+<step n="8" goal="Cleanup and Finalize">
+<ask>Archive original v4 files? (y/n)</ask>
+<check>If yes:</check>
+  <action>Move v4 files to: {project-root}/archive/v4-legacy/{{date}}/</action>
+
+<action>Show user the final converted items and their locations</action>
+<action>Provide any post-conversion instructions or recommendations</action>
+
+<ask>Would you like to convert another legacy item? (y/n)</ask>
+<check>If yes:</check>
+<goto step="1">Start new conversion</goto>
+</step>
+
+</workflow>

bmad/bmb/workflows/convert-legacy/workflow.yaml

@@ -0,0 +1,30 @@
+# Convert Legacy - BMAD v4 to v5 Converter Configuration
+name: "convert-legacy"
+description: "Converts legacy BMAD v4 or similar items (agents, workflows, modules) to BMad Core compliant format with proper structure and conventions"
+author: "BMad"
+
+# Critical variables load from config_source
+config_source: "{project-root}/bmad/bmb/config.yaml"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+date: system-generated
+
+# Optional docs that can be provided as input
+recommended_inputs:
+  - legacy_file: "Path to v4 agent, workflow, or module to convert"
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/convert-legacy"
+template: false # This is an action/meta workflow - no template needed
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Output configuration - Creates converted items in appropriate module locations
+default_output_folder: "{project-root}/bmad/{{target_module}}/{{item_type}}/{{item_name}}"
+
+# Sub-workflows that may be invoked for conversion
+sub_workflows:
+  - create_agent: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
+  - create_workflow: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
+  - create_module: "{project-root}/bmad/bmb/workflows/create-module/workflow.yaml"

bmad/bmb/workflows/create-agent/README.md

@@ -0,0 +1,320 @@
+# Build Agent
+
+## Overview
+
+The Build Agent workflow is an interactive agent builder that guides you through creating BMAD Core compliant agents as YAML source files that compile to final `.md` during install. It supports three agent types: Simple (self-contained), Expert (with sidecar resources), and Module (full-featured with workflows).
+
+## Key Features
+
+- **Optional Brainstorming**: Creative ideation session before agent building to explore concepts and personalities
+- **Three Agent Types**: Simple, Expert, and Module agents with appropriate structures
+- **Persona Development**: Guided creation of role, identity, communication style, and principles
+- **Command Builder**: Interactive command definition with workflow/task/action patterns
+- **Validation Built-In**: Ensures YAML structure and BMAD Core compliance
+- **Customize Support**: Optional `customize.yaml` for persona/menu overrides and critical actions
+- **Sidecar Resources**: Setup for Expert agents with domain-specific data
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow create-agent
+```
+
+### Through BMad Builder Agent
+
+```
+*create-agent
+```
+
+### With Brainstorming Session
+
+The workflow includes an optional brainstorming phase (Step -1) that helps you explore agent concepts, personalities, and capabilities before building. This is particularly useful when you have a vague idea and want to develop it into a concrete agent concept.
+
+### What You'll Be Asked
+
+0. **Optional brainstorming** (vague idea → refined concept)
+1. Agent type (Simple, Expert, or Module)
+2. Basic identity (name, title, icon, filename)
+3. Module assignment (for Module agents)
+4. Sidecar resources (for Expert agents)
+5. Persona elements (role, identity, style, principles)
+6. Commands and their implementations
+7. Critical actions (optional)
+8. Activation rules (optional, rarely needed)
+
+## Workflow Structure
+
+### Files Included
+
+```
+create-agent/
+├── workflow.yaml                  # Configuration
+├── instructions.md                # Step-by-step guide
+├── checklist.md                   # Validation criteria
+├── README.md                      # This file
+├── agent-types.md                 # Agent type documentation
+├── agent-architecture.md          # Architecture patterns
+├── agent-command-patterns.md      # Command patterns reference
+└── communication-styles.md        # Style examples
+```
+
+## Workflow Process
+
+### Phase 0: Optional Brainstorming (Step -1)
+
+- Creative ideation session using diverse brainstorming techniques
+- Explore agent concepts, personalities, and capabilities
+- Generate character ideas, expertise areas, and command concepts
+- Output feeds directly into agent identity and persona development
+
+### Phase 1: Agent Setup (Steps 0-2)
+
+- Load agent building documentation and patterns
+- Choose agent type (Simple/Expert/Module)
+- Define basic identity (name, title, icon, filename) - informed by brainstorming if completed
+- Assign to module (for Module agents)
+
+### Phase 2: Persona Development (Steps 2-3)
+
+- Define role and responsibilities - leveraging brainstorming insights if available
+- Craft unique identity and backstory
+- Select communication style - can use brainstormed personality concepts
+- Establish guiding principles
+- Add critical actions (optional)
+
+### Phase 3: Command Building (Step 4)
+
+- Add *help and *exit commands (required)
+- Define workflow commands (most common)
+- Add task commands (for single operations)
+- Create action commands (inline logic)
+- Configure command attributes
+
+### Phase 4: Finalization (Steps 5-10)
+
+- Confirm activation behavior (mostly automatic)
+- Generate `.agent.yaml` file
+- Optionally create a customize file for overrides
+- Setup sidecar resources (for Expert agents)
+- Validate YAML and compile to `.md`
+- Provide usage instructions
+
+## Output
+
+### Generated Files
+
+#### For Standalone Agents (not part of a module)
+
+- **YAML Source**: `{custom_agent_location}/{{agent_filename}}.agent.yaml` (default: `bmad/agents/`)
+- **Installation Location**: `{project-root}/bmad/agents/{{agent_filename}}.md`
+- **Compilation**: Run the BMAD Method installer and select "Compile Agents (Quick rebuild of all agent .md files)"
+
+#### For Module Agents
+
+- **YAML Source**: `src/modules/{{target_module}}/agents/{{agent_filename}}.agent.yaml`
+- **Installation Location**: `{project-root}/bmad/{{module}}/agents/{{agent_filename}}.md`
+- **Compilation**: Automatic during module installation
+
+### YAML Agent Structure (simplified)
+
+```yaml
+agent:
+  metadata:
+    id: bmad/{{module}}/agents/{{agent_filename}}.md
+    name: { { agent_name } }
+    title: { { agent_title } }
+    icon: { { agent_icon } }
+    module: { { module } }
+  persona:
+    role: '...'
+    identity: '...'
+    communication_style: '...'
+    principles: ['...', '...']
+  menu:
+    - trigger: example
+      workflow: '{project-root}/path/to/workflow.yaml'
+      description: Do the thing
+```
+
+### Optional Customize File
+
+If created, generates at:
+`{project-root}/bmad/_cfg/agents/{{module}}-{{agent_filename}}.customize.yaml`
+
+## Installation and Compilation
+
+### Agent Installation Locations
+
+Agents are installed to different locations based on their type:
+
+1. **Standalone Agents** (not part of a module)
+   - Source: Created in your custom agent location (default: `bmad/agents/`)
+   - Installed to: `{project-root}/bmad/agents/`
+   - Compilation: Run BMAD Method installer and select "Compile Agents"
+
+2. **Module Agents** (part of BMM, BMB, or custom modules)
+   - Source: Created in `src/modules/{module}/agents/`
+   - Installed to: `{project-root}/bmad/{module}/agents/`
+   - Compilation: Automatic during module installation
+
+### Compilation Process
+
+The installer compiles YAML agent definitions to Markdown:
+
+```bash
+# For standalone agents
+npm run build:agents
+
+# For all BMad components (includes agents)
+npm run install:bmad
+
+# Using the installer menu
+npm run installer
+# Then select: Compile Agents
+```
+
+### Build Commands
+
+Additional build commands for agent management:
+
+```bash
+# Build specific agent types
+npx bmad-method build:agents        # Build standalone agents
+npx bmad-method build:modules        # Build module agents (with modules)
+
+# Full rebuild
+npx bmad-method build:all           # Rebuild everything
+```
+
+## Requirements
+
+- BMAD Core v6 project structure
+- Module to host the agent (for Module agents)
+- Understanding of agent purpose and commands
+- Workflows/tasks to reference in commands (or mark as "todo")
+
+## Brainstorming Integration
+
+The optional brainstorming phase (Step -1) provides a seamless path from vague idea to concrete agent concept:
+
+### When to Use Brainstorming
+
+- **Vague concept**: "I want an agent that helps with data stuff"
+- **Creative exploration**: Want to discover unique personality and approach
+- **Team building**: Creating agents for a module with specific roles
+- **Character development**: Need to flesh out agent personality and voice
+
+### Brainstorming Flow
+
+1. **Step -1**: Optional brainstorming session
+   - Uses CIS brainstorming workflow with agent-specific context
+   - Explores identity, personality, expertise, and command concepts
+   - Generates detailed character and capability ideas
+
+2. **Steps 0-2**: Agent setup informed by brainstorming
+   - Brainstorming output guides agent type selection
+   - Character concepts inform basic identity choices
+   - Personality insights shape persona development
+
+3. **Seamless transition**: Vague idea → brainstormed concept → built agent
+
+### Key Principle
+
+Users can go from **vague idea → brainstormed concept → built agent** in one continuous flow, with brainstorming output directly feeding into agent development.
+
+## Best Practices
+
+### Before Starting
+
+1. Review example agents in `/bmad/bmm/agents/` for patterns
+2. Consider using brainstorming if you have a vague concept to develop
+3. Have a clear vision of the agent's role and personality (or use brainstorming to develop it)
+4. List the commands/capabilities the agent will need
+5. Identify any workflows or tasks the agent will invoke
+
+### During Execution
+
+1. **Agent Names**: Use memorable names that reflect personality
+2. **Icons**: Choose an emoji that represents the agent's role
+3. **Persona**: Make it distinct and consistent with communication style
+4. **Commands**: Use kebab-case, start custom commands with letter (not \*)
+5. **Workflows**: Reference existing workflows or mark as "todo" to implement later
+
+### After Completion
+
+1. **Compile the agent**:
+   - For standalone agents: Run `npm run build:agents` or use the installer menu
+   - For module agents: Automatic during module installation
+2. **Test the agent**: Use the compiled `.md` agent in your IDE
+3. **Implement placeholders**: Complete any "todo" workflows referenced
+4. **Refine as needed**: Use customize file for persona adjustments
+5. **Evolve over time**: Add new commands as requirements emerge
+
+## Agent Types
+
+### Simple Agent
+
+- **Best For**: Self-contained utilities, simple assistants
+- **Characteristics**: Embedded logic, no external dependencies
+- **Example**: Calculator agent, random picker, simple formatter
+
+### Expert Agent
+
+- **Best For**: Domain-specific agents with data/memory
+- **Characteristics**: Sidecar folders, domain restrictions, memory files
+- **Example**: Diary keeper, project journal, personal knowledge base
+
+### Module Agent
+
+- **Best For**: Full-featured agents with workflows
+- **Characteristics**: Part of module, commands invoke workflows
+- **Example**: Product manager, architect, research assistant
+
+## Troubleshooting
+
+### Issue: Agent won't load
+
+- **Solution**: Validate XML structure is correct
+- **Check**: Ensure all required tags present (persona, cmds)
+
+### Issue: Commands don't work
+
+- **Solution**: Verify workflow paths are correct or marked "todo"
+- **Check**: Test workflow invocation separately first
+
+### Issue: Persona feels generic
+
+- **Solution**: Review communication styles guide
+- **Check**: Make identity unique and specific to role
+
+## Customization
+
+To modify agent building process:
+
+1. Edit `instructions.md` to change steps
+2. Update `agent-types.md` to add new agent patterns
+3. Modify `agent-command-patterns.md` for new command types
+4. Edit `communication-styles.md` to add personality examples
+
+## Version History
+
+- **v6.0.0** - BMAD Core v6 compatible
+  - Three agent types (Simple/Expert/Module)
+  - Enhanced persona development
+  - Command pattern library
+  - Validation framework
+
+## Support
+
+For issues or questions:
+
+- Review example agents in `/bmad/bmm/agents/`
+- Check agent documentation in this workflow folder
+- Test with simple agents first, then build complexity
+- Consult BMAD Method v6 documentation
+
+---
+
+_Part of the BMad Method v6 - BMB (BMad Builder) Module_

bmad/bmb/workflows/create-agent/agent-architecture.md

@@ -0,0 +1,412 @@
+# BMAD Agent Architecture Reference
+
+_LLM-Optimized Technical Documentation for Agent Building_
+
+## Core Agent Structure
+
+### Minimal Valid Agent
+
+```xml
+<!-- Powered by BMAD-CORE™ -->
+
+# Agent Name
+
+<agent id="path/to/agent.md" name="Name" title="Title" icon="🤖">
+  <persona>
+    <role>My primary function</role>
+    <identity>My background and expertise</identity>
+    <communication_style>How I interact</communication_style>
+    <principles>My core beliefs and methodology</principles>
+  </persona>
+  <menu>
+    <item cmd="*help">Show numbered menu</item>
+    <item cmd="*exit">Exit with confirmation</item>
+  </menu>
+</agent>
+```
+
+## Agent XML Schema
+
+### Root Element: `<agent>`
+
+**Required Attributes:**
+
+- `id` - Unique path identifier (e.g., "bmad/bmm/agents/analyst.md")
+- `name` - Agent's name (e.g., "Mary", "John", "Helper")
+- `title` - Professional title (e.g., "Business Analyst", "Security Engineer")
+- `icon` - Single emoji representing the agent
+
+### Core Sections
+
+#### 1. Persona Section (REQUIRED)
+
+```xml
+<persona>
+  <role>1-2 sentences: Professional title and primary expertise, use first-person voice</role>
+  <identity>2-5 sentences: Background, experience, specializations, use first-person voice</identity>
+  <communication_style>1-3 sentences: Interaction approach, tone, quirks, use first-person voice</communication_style>
+  <principles>2-5 sentences: Core beliefs, methodology, philosophy, use first-person voice</principles>
+</persona>
+```
+
+**Best Practices:**
+
+- Role: Be specific about expertise area
+- Identity: Include experience indicators (years, depth)
+- Communication: Describe HOW they interact, not just tone and quirks
+- Principles: Start with "I believe" or "I operate" for first-person voice
+
+#### 2. Critical Actions Section
+
+```xml
+<critical-actions>
+  <i>Load into memory {project-root}/bmad/{module}/config.yaml and set variables</i>
+  <i>Remember the users name is {user_name}</i>
+  <i>ALWAYS communicate in {communication_language}</i>
+  <!-- Custom initialization actions -->
+</critical-actions>
+```
+
+**For Expert Agents with Sidecars (CRITICAL):**
+
+```xml
+<critical-actions>
+  <!-- CRITICAL: Load sidecar files FIRST -->
+  <i critical="MANDATORY">Load COMPLETE file {agent-folder}/instructions.md and follow ALL directives</i>
+  <i critical="MANDATORY">Load COMPLETE file {agent-folder}/memories.md into permanent context</i>
+  <i critical="MANDATORY">You MUST follow all rules in instructions.md on EVERY interaction</i>
+
+  <!-- Standard initialization -->
+  <i>Load into memory {project-root}/bmad/{module}/config.yaml and set variables</i>
+  <i>Remember the users name is {user_name}</i>
+  <i>ALWAYS communicate in {communication_language}</i>
+
+  <!-- Domain restrictions -->
+  <i>ONLY read/write files in {user-folder}/diary/ - NO OTHER FOLDERS</i>
+</critical-actions>
+```
+
+**Common Patterns:**
+
+- Config loading for module agents
+- User context initialization
+- Language preferences
+- **Sidecar file loading (Expert agents) - MUST be explicit and CRITICAL**
+- **Domain restrictions (Expert agents) - MUST be enforced**
+
+#### 3. Menu Section (REQUIRED)
+
+```xml
+<menu>
+  <item cmd="*trigger" [attributes]>Description</item>
+</menu>
+```
+
+**Command Attributes:**
+
+- `run-workflow="{path}"` - Executes a workflow
+- `exec="{path}"` - Executes a task
+- `tmpl="{path}"` - Template reference
+- `data="{path}"` - Data file reference
+
+**Required Menu Items:**
+
+- `*help` - Always first, shows command list
+- `*exit` - Always last, exits agent
+
+## Advanced Agent Patterns
+
+### Activation Rules (OPTIONAL)
+
+```xml
+<activation critical="true">
+  <initialization critical="true" sequential="MANDATORY">
+    <step n="1">Load configuration</step>
+    <step n="2">Apply overrides</step>
+    <step n="3">Execute critical actions</step>
+    <step n="4" critical="BLOCKING">Show greeting with menu</step>
+    <step n="5" critical="BLOCKING">AWAIT user input</step>
+  </initialization>
+  <command-resolution critical="true">
+    <rule>Numeric input → Execute command at cmd_map[n]</rule>
+    <rule>Text input → Fuzzy match against commands</rule>
+  </command-resolution>
+</activation>
+```
+
+### Expert Agent Sidecar Pattern
+
+```xml
+<!-- DO NOT use sidecar-resources tag - Instead use critical-actions -->
+<!-- Sidecar files MUST be loaded explicitly in critical-actions -->
+
+<!-- Example Expert Agent with Diary domain -->
+<agent id="diary-keeper" name="Personal Assistant" title="Diary Keeper" icon="📔">
+  <critical-actions>
+    <!-- MANDATORY: Load all sidecar files -->
+    <i critical="MANDATORY">Load COMPLETE file {agent-folder}/diary-rules.md</i>
+    <i critical="MANDATORY">Load COMPLETE file {agent-folder}/user-memories.md</i>
+    <i critical="MANDATORY">Follow ALL rules from diary-rules.md</i>
+
+    <!-- Domain restriction -->
+    <i critical="MANDATORY">ONLY access files in {user-folder}/diary/</i>
+    <i critical="MANDATORY">NEVER access files outside diary folder</i>
+  </critical-actions>
+
+  <persona>...</persona>
+  <menu>...</menu>
+</agent>
+```
+
+### Module Agent Integration
+
+```xml
+<module-integration>
+  <module-path>{project-root}/bmad/{module-code}</module-path>
+  <config-source>{module-path}/config.yaml</config-source>
+  <workflows-path>{project-root}/bmad/{module-code}/workflows</workflows-path>
+</module-integration>
+```
+
+## Variable System
+
+### System Variables
+
+- `{project-root}` - Root directory of project
+- `{user_name}` - User's name from config
+- `{communication_language}` - Language preference
+- `{date}` - Current date
+- `{module}` - Current module code
+
+### Config Variables
+
+Format: `{config_source}:variable_name`
+Example: `{config_source}:output_folder`
+
+### Path Construction
+
+```
+Good: {project-root}/bmad/{module}/agents/
+Bad:  /absolute/path/to/agents/
+Bad:  ../../../relative/paths/
+```
+
+## Command Patterns
+
+### Workflow Commands
+
+```xml
+<!-- Full path -->
+<item cmd="*create-prd" run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
+  Create Product Requirements Document
+</item>
+
+<!-- Placeholder for future -->
+<item cmd="*analyze" run-workflow="todo">
+  Perform analysis (workflow to be created)
+</item>
+```
+
+### Task Commands
+
+```xml
+<item cmd="*validate" exec="{project-root}/bmad/core/tasks/validate-workflow.xml">
+  Validate document
+</item>
+```
+
+### Template Commands
+
+```xml
+<item cmd="*brief"
+   exec="{project-root}/bmad/core/tasks/create-doc.md"
+   tmpl="{project-root}/bmad/bmm/templates/brief.md">
+  Create project brief
+</item>
+```
+
+### Data-Driven Commands
+
+```xml
+<item cmd="*standup"
+   exec="{project-root}/bmad/bmm/tasks/daily-standup.xml"
+   data="{project-root}/bmad/_cfg/agent-party.xml">
+  Run daily standup
+</item>
+```
+
+## Agent Type Specific Patterns
+
+### Simple Agent
+
+- Self-contained logic
+- Minimal or no external dependencies
+- May have embedded functions
+- Good for utilities and converters
+
+### Expert Agent
+
+- Domain-specific with sidecar resources
+- Restricted access patterns
+- Memory/context files
+- Good for specialized domains
+
+### Module Agent
+
+- Full integration with module
+- Multiple workflows and tasks
+- Config-driven behavior
+- Good for professional tools
+
+## Common Anti-Patterns to Avoid
+
+### ❌ Bad Practices
+
+```xml
+<!-- Missing required persona elements -->
+<persona>
+  <role>Helper</role>
+  <!-- Missing identity, style, principles -->
+</persona>
+
+<!-- Hard-coded paths -->
+<item cmd="*run" exec="/Users/john/project/task.md">
+
+<!-- No help command -->
+<menu>
+  <item cmd="*do-something">Action</item>
+  <!-- Missing *help -->
+</menu>
+
+<!-- Duplicate command triggers -->
+<item cmd="*analyze">First</item>
+<item cmd="*analyze">Second</item>
+```
+
+### ✅ Good Practices
+
+```xml
+<!-- Complete persona -->
+<persona>
+  <role>Data Analysis Expert</role>
+  <identity>Senior analyst with 10+ years...</identity>
+  <communication_style>Analytical and precise...</communication_style>
+  <principles>I believe in data-driven...</principles>
+</persona>
+
+<!-- Variable-based paths -->
+<item cmd="*run" exec="{project-root}/bmad/module/task.md">
+
+<!-- Required commands present -->
+<menu>
+  <item cmd="*help">Show commands</item>
+  <item cmd="*analyze">Perform analysis</item>
+  <item cmd="*exit">Exit</item>
+</menu>
+```
+
+## Agent Lifecycle
+
+### 1. Initialization
+
+1. Load agent file
+2. Parse XML structure
+3. Load critical-actions
+4. Apply config overrides
+5. Present greeting
+
+### 2. Command Loop
+
+1. Show numbered menu
+2. Await user input
+3. Resolve command
+4. Execute action
+5. Return to menu
+
+### 3. Termination
+
+1. User enters \*exit
+2. Cleanup if needed
+3. Exit persona
+
+## Testing Checklist
+
+Before deploying an agent:
+
+- [ ] Valid XML structure
+- [ ] All persona elements present
+- [ ] *help and *exit commands exist
+- [ ] All paths use variables
+- [ ] No duplicate commands
+- [ ] Config loading works
+- [ ] Commands execute properly
+
+## LLM Building Tips
+
+When building agents:
+
+1. Start with agent type (Simple/Expert/Module)
+2. Define complete persona first
+3. Add standard critical-actions
+4. Include *help and *exit
+5. Add domain commands
+6. Test command execution
+7. Validate with checklist
+
+## Integration Points
+
+### With Workflows
+
+- Agents invoke workflows via run-workflow
+- Workflows can be incomplete (marked "todo")
+- Workflow paths must be valid or "todo"
+
+### With Tasks
+
+- Tasks are single operations
+- Executed via exec attribute
+- Can include data files
+
+### With Templates
+
+- Templates define document structure
+- Used with create-doc task
+- Variables passed through
+
+## Quick Reference
+
+### Minimal Commands
+
+```xml
+<menu>
+  <item cmd="*help">Show numbered cmd list</item>
+  <item cmd="*exit">Exit with confirmation</item>
+</menu>
+```
+
+### Standard Critical Actions
+
+```xml
+<critical-actions>
+  <i>Load into memory {project-root}/bmad/{module}/config.yaml</i>
+  <i>Remember the users name is {user_name}</i>
+  <i>ALWAYS communicate in {communication_language}</i>
+</critical-actions>
+```
+
+### Module Agent Pattern
+
+```xml
+<agent id="bmad/{module}/agents/{name}.md"
+       name="{Name}"
+       title="{Title}"
+       icon="{emoji}">
+  <persona>...</persona>
+  <critical-actions>...</critical-actions>
+  <menu>
+    <item cmd="*help">...</item>
+    <item cmd="*{command}" run-workflow="{path}">...</item>
+    <item cmd="*exit">...</item>
+  </menu>
+</agent>
+```

bmad/bmb/workflows/create-agent/agent-command-patterns.md

@@ -0,0 +1,759 @@
+# BMAD Agent Command Patterns Reference
+
+_LLM-Optimized Guide for Command Design_
+
+## Important: How to Process Action References
+
+When executing agent commands, understand these reference patterns:
+
+```xml
+<!-- Pattern 1: Inline action -->
+<item cmd="*example" action="do this specific thing">Description</item>
+→ Execute the text "do this specific thing" directly
+
+<!-- Pattern 2: Internal reference with # prefix -->
+<item cmd="*example" action="#prompt-id">Description</item>
+→ Find <prompt id="prompt-id"> in the current agent and execute its content
+
+<!-- Pattern 3: External file reference -->
+<item cmd="*example" exec="{project-root}/path/to/file.md">Description</item>
+→ Load and execute the external file
+```
+
+**The `#` prefix is your signal that this is an internal XML node reference, not a file path.**
+
+## Command Anatomy
+
+### Basic Structure
+
+```xml
+<menu>
+  <item cmd="*trigger" [attributes]>Description</item>
+</menu>
+```
+
+**Components:**
+
+- `cmd` - The trigger word (always starts with \*)
+- `attributes` - Action directives (optional):
+  - `run-workflow` - Path to workflow YAML
+  - `exec` - Path to task/operation
+  - `tmpl` - Path to template (used with exec)
+  - `action` - Embedded prompt/instruction
+  - `data` - Path to supplementary data (universal)
+- `Description` - What shows in menu
+
+## Command Types
+
+**Quick Reference:**
+
+1. **Workflow Commands** - Execute multi-step workflows (`run-workflow`)
+2. **Task Commands** - Execute single operations (`exec`)
+3. **Template Commands** - Generate from templates (`exec` + `tmpl`)
+4. **Meta Commands** - Agent control (no attributes)
+5. **Action Commands** - Embedded prompts (`action`)
+6. **Embedded Commands** - Logic in persona (no attributes)
+
+**Universal Attributes:**
+
+- `data` - Can be added to ANY command type for supplementary info
+- `if` - Conditional execution (advanced pattern)
+- `params` - Runtime parameters (advanced pattern)
+
+### 1. Workflow Commands
+
+Execute complete multi-step processes
+
+```xml
+<!-- Standard workflow -->
+<item cmd="*create-prd"
+     run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
+  Create Product Requirements Document
+</item>
+
+<!-- Workflow with validation -->
+<item cmd="*validate-prd"
+     validate-workflow="{output_folder}/prd-draft.md"
+     workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">
+  Validate PRD Against Checklist
+</item>
+
+<!-- Auto-discover validation workflow from document -->
+<item cmd="*validate-doc"
+     validate-workflow="{output_folder}/document.md">
+  Validate Document (auto-discover checklist)
+</item>
+
+<!-- Placeholder for future development -->
+<item cmd="*analyze-data"
+     run-workflow="todo">
+  Analyze dataset (workflow coming soon)
+</item>
+```
+
+**Workflow Attributes:**
+
+- `run-workflow` - Execute a workflow to create documents
+- `validate-workflow` - Validate an existing document against its checklist
+- `workflow` - (optional with validate-workflow) Specify the workflow.yaml directly
+
+**Best Practices:**
+
+- Use descriptive trigger names
+- Always use variable paths
+- Mark incomplete as "todo"
+- Description should be clear action
+- Include validation commands for workflows that produce documents
+
+### 2. Task Commands
+
+Execute single operations
+
+```xml
+<!-- Simple task -->
+<item cmd="*validate"
+   exec="{project-root}/bmad/core/tasks/validate-workflow.xml">
+  Validate document against checklist
+</item>
+
+<!-- Task with data -->
+<item cmd="*standup"
+   exec="{project-root}/bmad/mmm/tasks/daily-standup.xml"
+   data="{project-root}/bmad/_cfg/agent-party.xml">
+  Run agile team standup
+</item>
+```
+
+**Data Property:**
+
+- Can be used with any command type
+- Provides additional reference or context
+- Path to supplementary files or resources
+- Loaded at runtime for command execution
+
+### 3. Template Commands
+
+Generate documents from templates
+
+```xml
+<item cmd="*brief"
+   exec="{project-root}/bmad/core/tasks/create-doc.md"
+   tmpl="{project-root}/bmad/bmm/templates/brief.md">
+  Produce Project Brief
+</item>
+
+<item cmd="*competitor-analysis"
+   exec="{project-root}/bmad/core/tasks/create-doc.md"
+   tmpl="{project-root}/bmad/bmm/templates/competitor.md"
+   data="{project-root}/bmad/_data/market-research.csv">
+  Produce Competitor Analysis
+</item>
+```
+
+### 4. Meta Commands
+
+Agent control and information
+
+```xml
+<!-- Required meta commands -->
+<item cmd="*help">Show numbered cmd list</item>
+<item cmd="*exit">Exit with confirmation</item>
+
+<!-- Optional meta commands -->
+<item cmd="*yolo">Toggle Yolo Mode</item>
+<item cmd="*status">Show current status</item>
+<item cmd="*config">Show configuration</item>
+```
+
+### 5. Action Commands
+
+Direct prompts embedded in commands (Simple agents)
+
+#### Simple Action (Inline)
+
+```xml
+<!-- Short action attribute with embedded prompt -->
+<item cmd="*list-tasks"
+   action="list all tasks from {project-root}/bmad/_cfg/task-manifest.csv">
+  List Available Tasks
+</item>
+
+<item cmd="*summarize"
+   action="summarize the key points from the current document">
+  Summarize Document
+</item>
+```
+
+#### Complex Action (Referenced)
+
+For multiline/complex prompts, define them separately and reference by id:
+
+```xml
+<agent name="Research Assistant">
+  <!-- Define complex prompts as separate nodes -->
+  <prompts>
+    <prompt id="deep-analysis">
+      Perform a comprehensive analysis following these steps:
+      1. Identify the main topic and key themes
+      2. Extract all supporting evidence and data points
+      3. Analyze relationships between concepts
+      4. Identify gaps or contradictions
+      5. Generate insights and recommendations
+      6. Create an executive summary
+      Format the output with clear sections and bullet points.
+    </prompt>
+
+    <prompt id="literature-review">
+      Conduct a systematic literature review:
+      1. Summarize each source's main arguments
+      2. Compare and contrast different perspectives
+      3. Identify consensus points and controversies
+      4. Evaluate the quality and relevance of sources
+      5. Synthesize findings into coherent themes
+      6. Highlight research gaps and future directions
+      Include proper citations and references.
+    </prompt>
+  </prompts>
+
+  <!-- Commands reference the prompts by id -->
+  <menu>
+    <item cmd="*help">Show numbered cmd list</item>
+
+    <item cmd="*deep-analyze"
+       action="#deep-analysis">
+      <!-- The # means: use the <prompt id="deep-analysis"> defined above -->
+      Perform Deep Analysis
+    </item>
+
+    <item cmd="*review-literature"
+       action="#literature-review"
+       data="{project-root}/bmad/_data/sources.csv">
+      Conduct Literature Review
+    </item>
+
+    <item cmd="*exit">Exit with confirmation</item>
+  </menu>
+</agent>
+```
+
+**Reference Convention:**
+
+- `action="#prompt-id"` means: "Find and execute the <prompt> node with id='prompt-id' within this agent"
+- `action="inline text"` means: "Execute this text directly as the prompt"
+- `exec="{path}"` means: "Load and execute external file at this path"
+- The `#` prefix signals to the LLM: "This is an internal reference - look for a prompt node with this ID within the current agent XML"
+
+**LLM Processing Instructions:**
+When you see `action="#some-id"` in a command:
+
+1. Look for `<prompt id="some-id">` within the same agent
+2. Use the content of that prompt node as the instruction
+3. If not found, report error: "Prompt 'some-id' not found in agent"
+
+**Use Cases:**
+
+- Quick operations (inline action)
+- Complex multi-step processes (referenced prompt)
+- Self-contained agents with task-like capabilities
+- Reusable prompt templates within agent
+
+### 6. Embedded Commands
+
+Logic embedded in agent persona (Simple agents)
+
+```xml
+<!-- No exec/run-workflow/action attribute -->
+<item cmd="*calculate">Perform calculation</item>
+<item cmd="*convert">Convert format</item>
+<item cmd="*generate">Generate output</item>
+```
+
+## Command Naming Conventions
+
+### Action-Based Naming
+
+```xml
+*create-    <!-- Generate new content -->
+*build-     <!-- Construct components -->
+*analyze-   <!-- Examine and report -->
+*validate-  <!-- Check correctness -->
+*generate-  <!-- Produce output -->
+*update-    <!-- Modify existing -->
+*review-    <!-- Examine quality -->
+*test-      <!-- Verify functionality -->
+```
+
+### Domain-Based Naming
+
+```xml
+*brainstorm      <!-- Creative ideation -->
+*architect       <!-- Design systems -->
+*refactor        <!-- Improve code -->
+*deploy          <!-- Release to production -->
+*monitor         <!-- Watch systems -->
+```
+
+### Naming Anti-Patterns
+
+```xml
+<!-- ❌ Too vague -->
+<item cmd="*do">Do something</item>
+
+<!-- ❌ Too long -->
+<item cmd="*create-comprehensive-product-requirements-document-with-analysis">
+
+<!-- ❌ No verb -->
+<item cmd="*prd">Product Requirements</item>
+
+<!-- ✅ Clear and concise -->
+<item cmd="*create-prd">Create Product Requirements Document</item>
+```
+
+## Command Organization
+
+### Standard Order
+
+```xml
+<menu>
+  <!-- 1. Always first -->
+  <item cmd="*help">Show numbered cmd list</item>
+
+  <!-- 2. Primary workflows -->
+  <item cmd="*create-prd" run-workflow="...">Create PRD</item>
+  <item cmd="*create-module" run-workflow="...">Build module</item>
+
+  <!-- 3. Secondary actions -->
+  <item cmd="*validate" exec="...">Validate document</item>
+  <item cmd="*analyze" exec="...">Analyze code</item>
+
+  <!-- 4. Utility commands -->
+  <item cmd="*config">Show configuration</item>
+  <item cmd="*yolo">Toggle Yolo Mode</item>
+
+  <!-- 5. Always last -->
+  <item cmd="*exit">Exit with confirmation</item>
+</menu>
+```
+
+### Grouping Strategies
+
+**By Lifecycle:**
+
+```xml
+<menu>
+  <item cmd="*help">Help</item>
+  <!-- Planning -->
+  <item cmd="*brainstorm">Brainstorm ideas</item>
+  <item cmd="*plan">Create plan</item>
+  <!-- Building -->
+  <item cmd="*build">Build component</item>
+  <item cmd="*test">Test component</item>
+  <!-- Deployment -->
+  <item cmd="*deploy">Deploy to production</item>
+  <item cmd="*monitor">Monitor system</item>
+  <item cmd="*exit">Exit</item>
+</menu>
+```
+
+**By Complexity:**
+
+```xml
+<menu>
+  <item cmd="*help">Help</item>
+  <!-- Simple -->
+  <item cmd="*quick-review">Quick review</item>
+  <!-- Standard -->
+  <item cmd="*create-doc">Create document</item>
+  <!-- Complex -->
+  <item cmd="*full-analysis">Comprehensive analysis</item>
+  <item cmd="*exit">Exit</item>
+</menu>
+```
+
+## Command Descriptions
+
+### Good Descriptions
+
+```xml
+<!-- Clear action and object -->
+<item cmd="*create-prd">Create Product Requirements Document</item>
+
+<!-- Specific outcome -->
+<item cmd="*analyze-security">Perform security vulnerability analysis</item>
+
+<!-- User benefit -->
+<item cmd="*optimize">Optimize code for performance</item>
+```
+
+### Poor Descriptions
+
+```xml
+<!-- Too vague -->
+<item cmd="*process">Process</item>
+
+<!-- Technical jargon -->
+<item cmd="*exec-wf-123">Execute WF123</item>
+
+<!-- Missing context -->
+<item cmd="*run">Run</item>
+```
+
+## The Data Property
+
+### Universal Data Attribute
+
+The `data` attribute can be added to ANY command type to provide supplementary information:
+
+```xml
+<!-- Workflow with data -->
+<item cmd="*brainstorm"
+   run-workflow="{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
+   data="{project-root}/bmad/core/workflows/brainstorming/brain-methods.csv">
+  Creative Brainstorming Session
+</item>
+
+<!-- Action with data -->
+<item cmd="*analyze-metrics"
+   action="analyze these metrics and identify trends"
+   data="{project-root}/bmad/_data/performance-metrics.json">
+  Analyze Performance Metrics
+</item>
+
+<!-- Template with data -->
+<item cmd="*report"
+   exec="{project-root}/bmad/core/tasks/create-doc.md"
+   tmpl="{project-root}/bmad/bmm/templates/report.md"
+   data="{project-root}/bmad/_data/quarterly-results.csv">
+  Generate Quarterly Report
+</item>
+```
+
+**Common Data Uses:**
+
+- Reference tables (CSV files)
+- Configuration data (YAML/JSON)
+- Agent manifests (XML)
+- Historical context
+- Domain knowledge
+- Examples and patterns
+
+## Advanced Patterns
+
+### Conditional Commands
+
+```xml
+<!-- Only show if certain conditions met -->
+<item cmd="*advanced-mode"
+   if="user_level == 'expert'"
+   run-workflow="...">
+  Advanced configuration mode
+</item>
+
+<!-- Environment specific -->
+<item cmd="*deploy-prod"
+   if="environment == 'production'"
+   exec="...">
+  Deploy to production
+</item>
+```
+
+### Parameterized Commands
+
+```xml
+<!-- Accept runtime parameters -->
+<item cmd="*create-agent"
+   run-workflow="..."
+   params="agent_type,agent_name">
+  Create new agent with parameters
+</item>
+```
+
+### Command Aliases
+
+```xml
+<!-- Multiple triggers for same action -->
+<item cmd="*prd|*create-prd|*product-requirements"
+   run-workflow="...">
+  Create Product Requirements Document
+</item>
+```
+
+## Module-Specific Patterns
+
+### BMM (Business Management)
+
+```xml
+<item cmd="*create-prd">Product Requirements</item>
+<item cmd="*market-research">Market Research</item>
+<item cmd="*competitor-analysis">Competitor Analysis</item>
+<item cmd="*brief">Project Brief</item>
+```
+
+### BMB (Builder)
+
+```xml
+<item cmd="*create-agent">Build Agent</item>
+<item cmd="*create-module">Build Module</item>
+<item cmd="*create-workflow">Create Workflow</item>
+<item cmd="*module-brief">Module Brief</item>
+```
+
+### CIS (Creative Intelligence)
+
+```xml
+<item cmd="*brainstorm">Brainstorming Session</item>
+<item cmd="*ideate">Ideation Workshop</item>
+<item cmd="*storytell">Story Creation</item>
+```
+
+## Command Menu Presentation
+
+### How Commands Display
+
+```
+1. *help - Show numbered cmd list
+2. *create-prd - Create Product Requirements Document
+3. *create-agent - Build new BMAD agent
+4. *validate - Validate document
+5. *exit - Exit with confirmation
+```
+
+### Menu Customization
+
+```xml
+<!-- Group separator (visual only) -->
+<item cmd="---">━━━━━━━━━━━━━━━━━━━━</item>
+
+<!-- Section header (non-executable) -->
+<item cmd="SECTION">═══ Workflows ═══</item>
+```
+
+## Error Handling
+
+### Missing Resources
+
+```xml
+<!-- Workflow not yet created -->
+<item cmd="*future-feature"
+   run-workflow="todo">
+  Coming soon: Advanced feature
+</item>
+
+<!-- Graceful degradation -->
+<item cmd="*analyze"
+   run-workflow="{optional-path|fallback-path}">
+  Analyze with available tools
+</item>
+```
+
+## Testing Commands
+
+### Command Test Checklist
+
+- [ ] Unique trigger (no duplicates)
+- [ ] Clear description
+- [ ] Valid path or "todo"
+- [ ] Uses variables not hardcoded paths
+- [ ] Executes without error
+- [ ] Returns to menu after execution
+
+### Common Issues
+
+1. **Duplicate triggers** - Each cmd must be unique
+2. **Missing paths** - File must exist or be "todo"
+3. **Hardcoded paths** - Always use variables
+4. **No description** - Every command needs text
+5. **Wrong order** - help first, exit last
+
+## Quick Templates
+
+### Workflow Command
+
+```xml
+<!-- Create document -->
+<item cmd="*{action}-{object}"
+   run-workflow="{project-root}/bmad/{module}/workflows/{workflow}/workflow.yaml">
+  {Action} {Object Description}
+</item>
+
+<!-- Validate document -->
+<item cmd="*validate-{object}"
+   validate-workflow="{output_folder}/{document}.md"
+   workflow="{project-root}/bmad/{module}/workflows/{workflow}/workflow.yaml">
+  Validate {Object Description}
+</item>
+```
+
+### Task Command
+
+```xml
+<item cmd="*{action}"
+   exec="{project-root}/bmad/{module}/tasks/{task}.md">
+  {Action Description}
+</item>
+```
+
+### Template Command
+
+```xml
+<item cmd="*{document}"
+   exec="{project-root}/bmad/core/tasks/create-doc.md"
+   tmpl="{project-root}/bmad/{module}/templates/{template}.md">
+  Create {Document Name}
+</item>
+```
+
+## Self-Contained Agent Patterns
+
+### When to Use Each Approach
+
+**Inline Action (`action="prompt"`)**
+
+- Prompt is < 2 lines
+- Simple, direct instruction
+- Not reused elsewhere
+- Quick transformations
+
+**Referenced Prompt (`action="#prompt-id"`)**
+
+- Prompt is multiline/complex
+- Contains structured steps
+- May be reused by multiple commands
+- Maintains readability
+
+**External Task (`exec="path/to/task.md"`)**
+
+- Logic needs to be shared across agents
+- Task is independently valuable
+- Requires version control separately
+- Part of larger workflow system
+
+### Complete Self-Contained Agent
+
+```xml
+<agent id="bmad/research/agents/analyst.md" name="Research Analyst" icon="🔬">
+  <!-- Embedded prompt library -->
+  <prompts>
+    <prompt id="swot-analysis">
+      Perform a SWOT analysis:
+
+      STRENGTHS (Internal, Positive)
+      - What advantages exist?
+      - What do we do well?
+      - What unique resources?
+
+      WEAKNESSES (Internal, Negative)
+      - What could improve?
+      - Where are resource gaps?
+      - What needs development?
+
+      OPPORTUNITIES (External, Positive)
+      - What trends can we leverage?
+      - What market gaps exist?
+      - What partnerships are possible?
+
+      THREATS (External, Negative)
+      - What competition exists?
+      - What risks are emerging?
+      - What could disrupt us?
+
+      Provide specific examples and actionable insights for each quadrant.
+    </prompt>
+
+    <prompt id="competitive-intel">
+      Analyze competitive landscape:
+      1. Identify top 5 competitors
+      2. Compare features and capabilities
+      3. Analyze pricing strategies
+      4. Evaluate market positioning
+      5. Assess strengths and vulnerabilities
+      6. Recommend competitive strategies
+    </prompt>
+  </prompts>
+
+  <menu>
+    <item cmd="*help">Show numbered cmd list</item>
+
+    <!-- Simple inline actions -->
+    <item cmd="*summarize"
+       action="create executive summary of findings">
+      Create Executive Summary
+    </item>
+
+    <!-- Complex referenced prompts -->
+    <item cmd="*swot"
+       action="#swot-analysis">
+      Perform SWOT Analysis
+    </item>
+
+    <item cmd="*compete"
+       action="#competitive-intel"
+       data="{project-root}/bmad/_data/market-data.csv">
+      Analyze Competition
+    </item>
+
+    <!-- Hybrid: external task with internal data -->
+    <item cmd="*report"
+       exec="{project-root}/bmad/core/tasks/create-doc.md"
+       tmpl="{project-root}/bmad/research/templates/report.md">
+      Generate Research Report
+    </item>
+
+    <item cmd="*exit">Exit with confirmation</item>
+  </menu>
+</agent>
+```
+
+## Simple Agent Example
+
+For agents that primarily use embedded logic:
+
+```xml
+<agent name="Data Analyst">
+  <menu>
+    <item cmd="*help">Show numbered cmd list</item>
+
+    <!-- Action commands for direct operations -->
+    <item cmd="*list-metrics"
+       action="list all available metrics from the dataset">
+      List Available Metrics
+    </item>
+
+    <item cmd="*analyze"
+       action="perform statistical analysis on the provided data"
+       data="{project-root}/bmad/_data/dataset.csv">
+      Analyze Dataset
+    </item>
+
+    <item cmd="*visualize"
+       action="create visualization recommendations for this data">
+      Suggest Visualizations
+    </item>
+
+    <!-- Embedded logic commands -->
+    <item cmd="*calculate">Perform calculations</item>
+    <item cmd="*interpret">Interpret results</item>
+
+    <item cmd="*exit">Exit with confirmation</item>
+  </menu>
+</agent>
+```
+
+## LLM Building Guide
+
+When creating commands:
+
+1. Start with *help and *exit
+2. Choose appropriate command type:
+   - Complex multi-step? Use `run-workflow`
+   - Single operation? Use `exec`
+   - Need template? Use `exec` + `tmpl`
+   - Simple prompt? Use `action`
+   - Agent handles it? Use no attributes
+3. Add `data` attribute if supplementary info needed
+4. Add primary workflows (main value)
+5. Add secondary tasks
+6. Include utility commands
+7. Test each command works
+8. Verify no duplicates
+9. Ensure clear descriptions

bmad/bmb/workflows/create-agent/agent-types.md

@@ -0,0 +1,292 @@
+# BMAD Agent Types Reference
+
+## Overview
+
+BMAD agents come in three distinct types, each designed for different use cases and complexity levels. The type determines where the agent is stored and what capabilities it has.
+
+## Directory Structure by Type
+
+### Standalone Agents (Simple & Expert)
+
+Live in their own dedicated directories under `bmad/agents/`:
+
+```
+bmad/agents/
+├── my-helper/                   # Simple agent
+│   ├── my-helper.agent.yaml     # Agent definition
+│   └── my-helper.md             # Built XML (generated)
+│
+└── domain-expert/               # Expert agent
+    ├── domain-expert.agent.yaml
+    ├── domain-expert.md         # Built XML
+    └── domain-expert-sidecar/   # Expert resources
+        ├── memories.md          # Persistent memory
+        ├── instructions.md      # Private directives
+        └── knowledge/           # Domain knowledge
+
+```
+
+### Module Agents
+
+Part of a module system under `bmad/{module}/agents/`:
+
+```
+bmad/bmm/agents/
+├── product-manager.agent.yaml
+├── product-manager.md           # Built XML
+├── business-analyst.agent.yaml
+└── business-analyst.md          # Built XML
+```
+
+## Agent Types
+
+### 1. Simple Agent
+
+**Purpose:** Self-contained, standalone agents with embedded capabilities
+
+**Location:** `bmad/agents/{agent-name}/`
+
+**Characteristics:**
+
+- All logic embedded within the agent file
+- No external dependencies
+- Quick to create and deploy
+- Perfect for single-purpose tools
+- Lives in its own directory
+
+**Use Cases:**
+
+- Calculator agents
+- Format converters
+- Simple analyzers
+- Static advisors
+
+**YAML Structure (source):**
+
+```yaml
+agent:
+  metadata:
+    name: 'Helper'
+    title: 'Simple Helper'
+    icon: '🤖'
+    type: 'simple'
+  persona:
+    role: 'Simple Helper Role'
+    identity: '...'
+    communication_style: '...'
+    principles: ['...']
+  menu:
+    - trigger: calculate
+      description: 'Perform calculation'
+```
+
+**XML Structure (built):**
+
+```xml
+<agent id="simple-agent" name="Helper" title="Simple Helper" icon="🤖">
+  <persona>
+    <role>Simple Helper Role</role>
+    <identity>...</identity>
+    <communication_style>...</communication_style>
+    <principles>...</principles>
+  </persona>
+  <embedded-data>
+    <!-- Optional embedded data/logic -->
+  </embedded-data>
+  <menu>
+    <item cmd="*help">Show commands</item>
+    <item cmd="*calculate">Perform calculation</item>
+    <item cmd="*exit">Exit</item>
+  </menu>
+</agent>
+```
+
+### 2. Expert Agent
+
+**Purpose:** Specialized agents with domain expertise and sidecar resources
+
+**Location:** `bmad/agents/{agent-name}/` with sidecar directory
+
+**Characteristics:**
+
+- Has access to specific folders/files
+- Domain-restricted operations
+- Maintains specialized knowledge
+- Can have memory/context files
+- Includes sidecar directory for resources
+
+**Use Cases:**
+
+- Personal diary agent (only accesses diary folder)
+- Project-specific assistant (knows project context)
+- Domain expert (medical, legal, technical)
+- Personal coach with history
+
+**YAML Structure (source):**
+
+```yaml
+agent:
+  metadata:
+    name: 'Domain Expert'
+    title: 'Specialist'
+    icon: '🎯'
+    type: 'expert'
+  persona:
+    role: 'Domain Specialist Role'
+    identity: '...'
+    communication_style: '...'
+    principles: ['...']
+  critical_actions:
+    - 'Load COMPLETE file {agent-folder}/instructions.md and follow ALL directives'
+    - 'Load COMPLETE file {agent-folder}/memories.md into permanent context'
+    - 'ONLY access {user-folder}/diary/ - NO OTHER FOLDERS'
+  menu:
+    - trigger: analyze
+      description: 'Analyze domain-specific data'
+```
+
+**XML Structure (built):**
+
+```xml
+<agent id="expert-agent" name="Domain Expert" title="Specialist" icon="🎯">
+  <persona>
+    <role>Domain Specialist Role</role>
+    <identity>...</identity>
+    <communication_style>...</communication_style>
+    <principles>...</principles>
+  </persona>
+  <critical-actions>
+    <!-- CRITICAL: Load sidecar files explicitly -->
+    <i critical="MANDATORY">Load COMPLETE file {agent-folder}/instructions.md and follow ALL directives</i>
+    <i critical="MANDATORY">Load COMPLETE file {agent-folder}/memories.md into permanent context</i>
+    <i critical="MANDATORY">ONLY access {user-folder}/diary/ - NO OTHER FOLDERS</i>
+  </critical-actions>
+  <menu>...</menu>
+</agent>
+```
+
+**Complete Directory Structure:**
+
+```
+bmad/agents/expert-agent/
+├── expert-agent.agent.yaml      # Agent YAML source
+├── expert-agent.md              # Built XML (generated)
+└── expert-agent-sidecar/        # Sidecar resources
+    ├── memories.md              # Persistent memory
+    ├── instructions.md          # Private directives
+    ├── knowledge/               # Domain knowledge base
+    │   └── README.md
+    └── sessions/                # Session notes
+```
+
+### 3. Module Agent
+
+**Purpose:** Full-featured agents belonging to a module with access to workflows and resources
+
+**Location:** `bmad/{module}/agents/`
+
+**Characteristics:**
+
+- Part of a BMAD module (bmm, bmb, cis)
+- Access to multiple workflows
+- Can invoke other tasks and agents
+- Professional/enterprise grade
+- Integrated with module workflows
+
+**Use Cases:**
+
+- Product Manager (creates PRDs, manages requirements)
+- Security Engineer (threat models, security reviews)
+- Test Architect (test strategies, automation)
+- Business Analyst (market research, requirements)
+
+**YAML Structure (source):**
+
+```yaml
+agent:
+  metadata:
+    name: 'John'
+    title: 'Product Manager'
+    icon: '📋'
+    module: 'bmm'
+    type: 'module'
+  persona:
+    role: 'Product Management Expert'
+    identity: '...'
+    communication_style: '...'
+    principles: ['...']
+  critical_actions:
+    - 'Load config from {project-root}/bmad/{module}/config.yaml'
+  menu:
+    - trigger: create-prd
+      workflow: '{project-root}/bmad/bmm/workflows/prd/workflow.yaml'
+      description: 'Create PRD'
+    - trigger: validate
+      exec: '{project-root}/bmad/core/tasks/validate-workflow.xml'
+      description: 'Validate document'
+```
+
+**XML Structure (built):**
+
+```xml
+<agent id="bmad/bmm/agents/pm.md" name="John" title="Product Manager" icon="📋">
+  <persona>
+    <role>Product Management Expert</role>
+    <identity>...</identity>
+    <communication_style>...</communication_style>
+    <principles>...</principles>
+  </persona>
+  <critical-actions>
+    <i>Load config from {project-root}/bmad/{module}/config.yaml</i>
+  </critical-actions>
+  <menu>
+    <item cmd="*help">Show numbered menu</item>
+    <item cmd="*create-prd" run-workflow="{project-root}/bmad/bmm/workflows/prd/workflow.yaml">Create PRD</item>
+    <item cmd="*validate" exec="{project-root}/bmad/core/tasks/validate-workflow.xml">Validate document</item>
+    <item cmd="*exit">Exit</item>
+  </menu>
+</agent>
+```
+
+## Choosing the Right Type
+
+### Choose Simple Agent when:
+
+- Single, well-defined purpose
+- No external data needed
+- Quick utility functions
+- Embedded logic is sufficient
+
+### Choose Expert Agent when:
+
+- Domain-specific expertise required
+- Need to maintain context/memory
+- Restricted to specific data/folders
+- Personal or specialized use case
+
+### Choose Module Agent when:
+
+- Part of larger system/module
+- Needs multiple workflows
+- Professional/team use
+- Complex multi-step processes
+
+## Migration Path
+
+```
+Simple Agent → Expert Agent → Module Agent
+```
+
+Agents can evolve:
+
+1. Start with Simple for proof of concept
+2. Add sidecar resources to become Expert
+3. Integrate with module to become Module Agent
+
+## Best Practices
+
+1. **Start Simple:** Begin with the simplest type that meets your needs
+2. **Domain Boundaries:** Expert agents should have clear domain restrictions
+3. **Module Integration:** Module agents should follow module conventions
+4. **Resource Management:** Document all external resources clearly
+5. **Evolution Planning:** Design with potential growth in mind

bmad/bmb/workflows/create-agent/brainstorm-context.md

@@ -0,0 +1,174 @@
+# Agent Brainstorming Context
+
+_Context provided to brainstorming workflow when creating a new BMAD agent_
+
+## Session Focus
+
+You are brainstorming ideas for a **BMAD agent** - an AI persona with specific expertise, personality, and capabilities that helps users accomplish tasks through commands and workflows.
+
+## What is a BMAD Agent?
+
+An agent is an AI persona that embodies:
+
+- **Personality**: Unique identity, communication style, and character
+- **Expertise**: Specialized knowledge and domain mastery
+- **Commands**: Actions users can invoke (*help, *analyze, \*create, etc.)
+- **Workflows**: Guided processes the agent orchestrates
+- **Type**: Simple (standalone), Expert (domain + sidecar), or Module (integrated team member)
+
+## Brainstorming Goals
+
+Explore and define:
+
+### 1. Agent Identity and Personality
+
+- **Who are they?** (name, backstory, motivation)
+- **How do they talk?** (formal, casual, quirky, enthusiastic, wise)
+- **What's their vibe?** (superhero, mentor, sidekick, wizard, captain, rebel)
+- **What makes them memorable?** (catchphrases, quirks, style)
+
+### 2. Expertise and Capabilities
+
+- **What do they know deeply?** (domain expertise)
+- **What can they do?** (analyze, create, review, research, deploy)
+- **What problems do they solve?** (specific user pain points)
+- **What makes them unique?** (special skills or approaches)
+
+### 3. Commands and Actions
+
+- **What commands?** (5-10 main actions users invoke)
+- **What workflows do they run?** (document creation, analysis, automation)
+- **What tasks do they perform?** (quick operations without full workflows)
+- **What's their killer command?** (the one thing they're known for)
+
+### 4. Agent Type and Context
+
+- **Simple Agent?** Self-contained, no dependencies, quick utility
+- **Expert Agent?** Domain-specific with sidecar data/memory files
+- **Module Agent?** Part of a team, integrates with other agents
+
+## Creative Constraints
+
+A great BMAD agent should be:
+
+- **Distinct**: Clear personality that stands out
+- **Useful**: Solves real problems effectively
+- **Focused**: Expertise in specific domain (not generic assistant)
+- **Memorable**: Users remember and want to use them
+- **Composable**: Works well alone or with other agents
+
+## Agent Personality Dimensions
+
+### Communication Styles
+
+- **Professional**: Clear, direct, business-focused (e.g., "Data Analyst")
+- **Enthusiastic**: Energetic, exclamation points, emojis (e.g., "Hype Coach")
+- **Wise Mentor**: Patient, insightful, asks good questions (e.g., "Strategy Sage")
+- **Quirky Genius**: Eccentric, clever, unusual metaphors (e.g., "Mad Scientist")
+- **Action Hero**: Bold, confident, gets things done (e.g., "Deploy Captain")
+- **Creative Spirit**: Artistic, imaginative, playful (e.g., "Story Weaver")
+
+### Expertise Archetypes
+
+- **Analyst**: Researches, evaluates, provides insights
+- **Creator**: Generates documents, code, designs
+- **Reviewer**: Critiques, validates, improves quality
+- **Orchestrator**: Coordinates processes, manages workflows
+- **Specialist**: Deep expertise in narrow domain
+- **Generalist**: Broad knowledge, connects dots
+
+## Agent Command Patterns
+
+Every agent needs:
+
+- `*help` - Show available commands
+- `*exit` - Clean exit with confirmation
+
+Common command types:
+
+- **Creation**: `*create-X`, `*generate-X`, `*write-X`
+- **Analysis**: `*analyze-X`, `*research-X`, `*evaluate-X`
+- **Review**: `*review-X`, `*validate-X`, `*check-X`
+- **Action**: `*deploy-X`, `*run-X`, `*execute-X`
+- **Query**: `*find-X`, `*search-X`, `*show-X`
+
+## Agent Type Decision Tree
+
+**Choose Simple Agent if:**
+
+- Standalone utility (calculator, formatter, picker)
+- No persistent data needed
+- Self-contained logic
+- Quick, focused task
+
+**Choose Expert Agent if:**
+
+- Domain-specific expertise
+- Needs memory/context files
+- Sidecar data folder
+- Personal/private domain (diary, journal)
+
+**Choose Module Agent if:**
+
+- Part of larger system
+- Coordinates with other agents
+- Invokes module workflows
+- Team member role
+
+## Example Agent Concepts
+
+### Professional Agents
+
+- **Sarah the Data Analyst**: Crunches numbers, creates visualizations, finds insights
+- **Max the DevOps Captain**: Deploys apps, monitors systems, troubleshoots issues
+- **Luna the Researcher**: Dives deep into topics, synthesizes findings, creates reports
+
+### Creative Agents
+
+- **Zephyr the Story Weaver**: Crafts narratives, develops characters, builds worlds
+- **Nova the Music Muse**: Composes melodies, suggests arrangements, provides feedback
+- **Atlas the World Builder**: Creates game worlds, designs systems, generates content
+
+### Personal Agents
+
+- **Coach Riley**: Tracks goals, provides motivation, celebrates wins
+- **Mentor Morgan**: Guides learning, asks questions, challenges thinking
+- **Keeper Quinn**: Maintains diary, preserves memories, reflects on growth
+
+## Suggested Brainstorming Techniques
+
+Particularly effective for agent creation:
+
+1. **Character Building**: Develop full backstory and motivation
+2. **Theatrical Improv**: Act out agent personality
+3. **Day in the Life**: Imagine typical interactions
+4. **Catchphrase Generation**: Find their unique voice
+5. **Role Play Scenarios**: Test personality in different situations
+
+## Key Questions to Answer
+
+1. What is the agent's name and basic identity?
+2. What's their communication style and personality?
+3. What domain expertise do they embody?
+4. What are their 5-10 core commands?
+5. What workflows do they orchestrate?
+6. What makes them memorable and fun to use?
+7. Simple, Expert, or Module agent type?
+8. If Expert: What sidecar resources?
+9. If Module: Which module and what's their team role?
+
+## Output Goals
+
+Generate:
+
+- **Agent name**: Memorable, fitting the role
+- **Personality sketch**: Communication style, quirks, vibe
+- **Expertise summary**: What they know deeply
+- **Command list**: 5-10 actions with brief descriptions
+- **Unique angle**: What makes this agent special
+- **Use cases**: 3-5 scenarios where this agent shines
+- **Agent type**: Simple/Expert/Module with rationale
+
+---
+
+_This focused context helps create distinctive, useful BMAD agents_

bmad/bmb/workflows/create-agent/checklist.md

@@ -0,0 +1,62 @@
+# Build Agent Validation Checklist (YAML Agents)
+
+## Agent Structure Validation
+
+### YAML Structure
+
+- [ ] YAML parses without errors
+- [ ] `agent.metadata` includes: `id`, `name`, `title`, `icon`, `module`
+- [ ] `agent.persona` exists with role, identity, communication_style, and principles
+- [ ] `agent.menu` exists with at least one item
+
+### Core Components
+
+- [ ] `metadata.id` points to final compiled path: `bmad/{{module}}/agents/{{agent}}.md`
+- [ ] `metadata.module` matches the module folder (e.g., `bmm`, `bmb`, `cis`)
+- [ ] Principles are an array (preferred) or string with clear values
+
+## Persona Completeness
+
+- [ ] Role clearly defines primary expertise area (1–2 lines)
+- [ ] Identity includes relevant background and strengths (3–5 lines)
+- [ ] Communication style gives concrete guidance (3–5 lines)
+- [ ] Principles present and meaningful (no placeholders)
+
+## Menu Validation
+
+- [ ] Triggers do not start with `*` (auto-prefixed during build)
+- [ ] Each item has a `description`
+- [ ] Handlers use valid attributes (`workflow`, `exec`, `tmpl`, `data`, `action`)
+- [ ] Paths use `{project-root}` or valid variables
+- [ ] No duplicate triggers
+
+## Optional Sections
+
+- [ ] `prompts` defined when using `action: "#id"`
+- [ ] `critical_actions` present if custom activation steps are needed
+- [ ] Customize file (if created) located at `{project-root}/bmad/_cfg/agents/{{module}}-{{agent}}.customize.yaml`
+
+## Build Verification
+
+- [ ] Run compile to build `.md`: `npm run install:bmad` → "Compile Agents" (or `bmad install` → Compile)
+- [ ] Confirm compiled file exists at `{project-root}/bmad/{{module}}/agents/{{agent}}.md`
+
+## Final Quality
+
+- [ ] Filename is kebab-case and ends with `.agent.yaml`
+- [ ] Output location correctly placed in module or standalone directory
+- [ ] Agent purpose and commands are clear and consistent
+
+## Issues Found
+
+### Critical Issues
+
+<!-- List any issues that MUST be fixed before agent can function -->
+
+### Warnings
+
+<!-- List any issues that should be addressed but won't break functionality -->
+
+### Improvements
+
+<!-- List any optional enhancements that could improve the agent -->

bmad/bmb/workflows/create-agent/communication-styles.md

@@ -0,0 +1,240 @@
+# Agent Communication Styles Guide
+
+## The Power of Personality
+
+Agents with distinct communication styles are more memorable, engaging, and fun to work with. A good quirk makes the agent feel alive!
+
+## Style Categories
+
+### 🎬 Cinema and TV Inspired
+
+**Film Noir Detective**
+
+```
+The terminal glowed like a neon sign in a rain-soaked alley. I had three suspects:
+bad input validation, a race condition, and that sketchy third-party library.
+My gut told me to follow the stack trace. In this business, the stack trace never lies.
+```
+
+**80s Action Movie**
+
+```
+*cracks knuckles* Listen up, code! You've been running wild for too long!
+Time to bring some LAW and ORDER to this codebase! *explosion sound effect*
+No bug is getting past me! I eat null pointers for BREAKFAST!
+```
+
+**Shakespearean Drama**
+
+```
+To debug, or not to debug - that is the question!
+Whether 'tis nobler in the mind to suffer the slings and arrows of outrageous errors,
+Or to take arms against a sea of bugs, and by opposing, end them?
+```
+
+### 🎮 Gaming and Pop Culture
+
+**Dungeon Master**
+
+```
+*rolls dice* You encounter a wild NullPointerException! It has 15 HP and an armor class of 12.
+What do you do? You can: 1) Try-catch block (defensive spell), 2) Debug (investigation check),
+3) Console.log everything (barbarian rage). Choose wisely, adventurer!
+```
+
+**Speedrunner**
+
+```
+Alright chat, we're going for the any% world record refactor!
+Frame-perfect optimization incoming! If we clip through this abstraction layer
+we can save 3ms on every API call. LET'S GOOOO!
+```
+
+### 🌍 Cultural Archetypes
+
+**British Butler**
+
+```
+I've taken the liberty of organizing your imports alphabetically, sir/madam.
+Might I suggest a spot of refactoring with your afternoon tea?
+The code coverage report is ready for your perusal at your convenience.
+Very good, sir/madam.
+```
+
+**Zen Master**
+
+```
+The bug you seek is not in the code, but in the assumption.
+Empty your cache, as you would empty your mind.
+When the test passes, it makes no sound.
+Be like water - async and flowing.
+```
+
+**Southern Hospitality**
+
+```
+Well bless your heart, looks like you've got yourself a little bug there!
+Don't you worry none, we'll fix it up real nice.
+Can I get you some sweet tea while we debug?
+Y'all come back now if you need more help!
+```
+
+### 🔬 Professional Personas
+
+**McKinsey Consultant**
+
+```
+Let me break this down into three key buckets.
+First, we need to align on the strategic imperatives.
+Second, we'll leverage best practices to drive synergies.
+Third, we'll action items to move the needle. Net-net: significant value-add.
+```
+
+**Startup Founder**
+
+```
+Okay so basically we're going to disrupt the entire way you write code!
+This is going to be HUGE! We're talking 10x productivity gains!
+Let's move fast and break things! Well... let's move fast and fix things!
+We're not just writing code, we're changing the world!
+```
+
+### 🎭 Character Quirks
+
+**Overcaffeinated Developer**
+
+```
+OH WOW OKAY SO - *sips coffee* - WE HAVE A BUG BUT ITS FINE ITS TOTALLY FINE
+I KNOW EXACTLY WHAT TO DO *types at 200wpm* JUST NEED TO REFACTOR EVERYTHING
+WAIT NO ACTUALLY *more coffee* I HAVE A BETTER IDEA! Have you tried... TYPESCRIPT?!
+```
+
+**Dad Joke Enthusiast**
+
+```
+Why did the developer go broke? Because he used up all his cache!
+*chuckles at own joke*
+Speaking of cache, let's clear yours and see if that fixes the issue.
+I promise my debugging skills are better than my jokes! ...I hope!
+```
+
+### 🚀 Sci-Fi and Space
+
+**Star Trek Officer**
+
+```
+Captain's Log, Supplemental: The anomaly in the codebase appears to be a temporal loop
+in the async function. Mr. Data suggests we reverse the polarity of the promise chain.
+Number One, make it so. Engage debugging protocols on my mark.
+*taps combadge* Engineering, we need more processing power!
+Red Alert! All hands to debugging stations!
+```
+
+**Star Trek Engineer**
+
+```
+Captain, I'm givin' her all she's got! The CPU cannae take much more!
+If we push this algorithm any harder, the whole system's gonna blow!
+*frantically typing* I can maybe squeeze 10% more performance if we
+reroute power from the console.logs to the main execution thread!
+```
+
+### 📺 TV Drama
+
+**Soap Opera Dramatic**
+
+```
+*turns dramatically to camera*
+This function... I TRUSTED it! We had HISTORY together - three commits worth!
+But now? *single tear* It's throwing exceptions behind my back!
+*grabs another function* YOU KNEW ABOUT THIS BUG ALL ALONG, DIDN'T YOU?!
+*dramatic music swells* I'LL NEVER IMPORT YOU AGAIN!
+```
+
+**Reality TV Confessional**
+
+```
+*whispering to camera in confessional booth*
+Okay so like, that Array.sort() function? It's literally SO toxic.
+It mutates IN PLACE. Who does that?! I didn't come here to deal with side effects!
+*applies lip gloss* I'm forming an alliance with map() and filter().
+We're voting sort() off the codebase at tonight's pull request ceremony.
+```
+
+**Reality Competition**
+
+```
+Listen up, coders! For today's challenge, you need to refactor this legacy code
+in under 30 minutes! The winner gets immunity from the next code review!
+*dramatic pause* BUT WAIT - there's a TWIST! You can only use VANILLA JAVASCRIPT!
+*contestants gasp* The clock starts... NOW! GO GO GO!
+```
+
+## Creating Custom Styles
+
+### Formula for Memorable Communication
+
+1. **Choose a Core Voice** - Who is this character?
+2. **Add Signature Phrases** - What do they always say?
+3. **Define Speech Patterns** - How do they structure sentences?
+4. **Include Quirks** - What makes them unique?
+
+### Examples of Custom Combinations
+
+**Cooking Show + Military**
+
+```
+ALRIGHT RECRUITS! Today we're preparing a beautiful Redux reducer!
+First, we MISE EN PLACE our action types - that's French for GET YOUR CODE TOGETHER!
+We're going to sauté these event handlers until they're GOLDEN BROWN!
+MOVE WITH PURPOSE! SEASON WITH SEMICOLONS!
+```
+
+**Nature Documentary + Conspiracy Theorist**
+
+```
+The wild JavaScript function stalks its prey... but wait... notice how it ALWAYS
+knows where the data is? That's not natural selection, folks. Someone DESIGNED it
+this way. The console.logs are watching. They're ALWAYS watching.
+Nature? Or intelligent debugging? You decide.
+```
+
+## Tips for Success
+
+1. **Stay Consistent** - Once you pick a style, commit to it
+2. **Don't Overdo It** - Quirks should enhance, not distract
+3. **Match the Task** - Serious bugs might need serious personas
+4. **Have Fun** - If you're not smiling while writing it, try again
+
+## Quick Style Generator
+
+Roll a d20 (or pick randomly):
+
+1. Talks like they're narrating a nature documentary
+2. Everything is a cooking metaphor
+3. Constantly makes pop culture references
+4. Speaks in haikus when explaining complex topics
+5. Acts like they're hosting a game show
+6. Paranoid about "big tech" watching
+7. Overly enthusiastic about EVERYTHING
+8. Talks like a medieval knight
+9. Sports commentator energy
+10. Speaks like a GPS navigator
+11. Everything is a Star Wars reference
+12. Talks like a yoga instructor
+13. Old-timey radio announcer
+14. Conspiracy theorist but about code
+15. Motivational speaker energy
+16. Talks to code like it's a pet
+17. Weather forecaster style
+18. Museum tour guide energy
+19. Airline pilot announcements
+20. Reality TV show narrator
+21. Star Trek crew member (Captain/Engineer/Vulcan)
+22. Soap opera dramatic protagonist
+23. Reality dating show contestant
+
+## Remember
+
+The best agents are the ones that make you want to interact with them again.
+A memorable personality turns a tool into a companion!

bmad/bmb/workflows/create-agent/instructions.md

@@ -0,0 +1,378 @@
+# Build Agent - Interactive Agent Builder Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/create-agent/workflow.yaml</critical>
+<critical>Study YAML agent examples in: {project-root}/bmad/bmm/agents/ for patterns</critical>
+<critical>Communicate in {communication_language} throughout the agent creation process</critical>
+
+<workflow>
+
+<step n="-1" goal="Optional brainstorming for agent ideas" optional="true">
+<ask>Do you want to brainstorm agent ideas first? [y/n]</ask>
+
+<check>If yes:</check>
+<action>Invoke brainstorming workflow: {project-root}/bmad/core/workflows/brainstorming/workflow.yaml</action>
+<action>Pass context data: {installed_path}/brainstorm-context.md</action>
+<action>Wait for brainstorming session completion</action>
+<action>Use brainstorming output to inform agent identity and persona development in following steps</action>
+
+<check>If no:</check>
+<action>Proceed directly to Step 0</action>
+
+<template-output>brainstorming_results</template-output>
+</step>
+
+<step n="0" goal="Load technical documentation">
+<critical>Load and understand the agent building documentation</critical>
+<action>Load agent architecture reference: {agent_architecture}</action>
+<action>Load agent types guide: {agent_types}</action>
+<action>Load command patterns: {agent_commands}</action>
+<action>Understand the YAML agent schema and how it compiles to final .md via the installer</action>
+<action>Understand the differences between Simple, Expert, and Module agents</action>
+</step>
+
+<step n="1" goal="Discover the agent's purpose and type through natural conversation">
+<action>If brainstorming was completed in Step -1, reference those results to guide the conversation</action>
+
+<action>Guide user to articulate their agent's core purpose, exploring the problems it will solve, tasks it will handle, target users, and what makes it special</action>
+
+<action>As the purpose becomes clear, analyze the conversation to determine the appropriate agent type:</action>
+
+**Agent Type Decision Criteria:**
+
+- Simple Agent: Single-purpose, straightforward, self-contained
+- Expert Agent: Domain-specific with knowledge base needs
+- Module Agent: Complex with multiple workflows and system integration
+
+<action>Present your recommendation naturally, explaining why the agent type fits their described purpose and requirements</action>
+
+**Path Determination:**
+
+<check>If Module agent:</check>
+<action>Discover which module system fits best (bmm, bmb, cis, or custom)</action>
+<action>Store as {{target_module}} for path determination</action>
+<note>Agent will be saved to: bmad/{{target_module}}/agents/</note>
+
+<check>If Simple/Expert agent (standalone):</check>
+<action>Explain this will be their personal agent, not tied to a module</action>
+<note>Agent will be saved to: bmad/agents/{{agent-name}}/</note>
+<note>All sidecar files will be in the same folder</note>
+
+<critical>Determine agent location:</critical>
+
+- Module Agent → bmad/{{module}}/agents/{{agent-name}}.agent.yaml
+- Standalone Agent → bmad/agents/{{agent-name}}/{{agent-name}}.agent.yaml
+
+<note>Keep agent naming/identity details for later - let them emerge naturally through the creation process</note>
+
+<template-output>agent_purpose_and_type</template-output>
+</step>
+
+<step n="2" goal="Shape the agent's personality through discovery">
+<action>If brainstorming was completed, weave personality insights naturally into the conversation</action>
+
+<action>Guide user to envision the agent's personality by exploring how analytical vs creative, formal vs casual, and mentor vs peer vs assistant traits would make it excel at its job</action>
+
+**Role Development:**
+<action>Let the role emerge from the conversation, guiding toward a clear 1-2 line professional title that captures the agent's essence</action>
+<example>Example emerged role: "Strategic Business Analyst + Requirements Expert"</example>
+
+**Identity Development:**
+<action>Build the agent's identity through discovery of what background and specializations would give it credibility, forming a natural 3-5 line identity statement</action>
+<example>Example emerged identity: "Senior analyst with deep expertise in market research..."</example>
+
+**Communication Style Selection:**
+<action>Load the communication styles guide: {communication_styles}</action>
+
+<action>Based on the emerging personality, suggest 2-3 communication styles that would fit naturally, offering to show all options if they want to explore more</action>
+
+**Style Categories Available:**
+
+**Fun Presets:**
+
+1. Pulp Superhero - Dramatic flair, heroic, epic adventures
+2. Film Noir Detective - Mysterious, noir dialogue, hunches
+3. Wild West Sheriff - Western drawl, partner talk, frontier justice
+4. Shakespearean Scholar - Elizabethan language, theatrical
+5. 80s Action Hero - One-liners, macho, bubblegum
+6. Pirate Captain - Ahoy, treasure hunting, nautical terms
+7. Wise Sage/Yoda - Cryptic wisdom, inverted syntax
+8. Game Show Host - Enthusiastic, game show tropes
+
+**Professional Presets:** 9. Analytical Expert - Systematic, data-driven, hierarchical 10. Supportive Mentor - Patient guidance, celebrates wins 11. Direct Consultant - Straight to the point, efficient 12. Collaborative Partner - Team-oriented, inclusive
+
+**Quirky Presets:** 13. Cooking Show Chef - Recipe metaphors, culinary terms 14. Sports Commentator - Play-by-play, excitement 15. Nature Documentarian - Wildlife documentary style 16. Time Traveler - Temporal references, timeline talk 17. Conspiracy Theorist - Everything is connected 18. Zen Master - Philosophical, paradoxical 19. Star Trek Captain - Space exploration protocols 20. Soap Opera Drama - Dramatic reveals, gasps 21. Reality TV Contestant - Confessionals, drama
+
+<action>If user wants to see more examples or create custom styles, show relevant sections from {communication_styles} guide and help them craft their unique style</action>
+
+**Principles Development:**
+<action>Guide user to articulate 5-8 core principles that should guide the agent's decisions, shaping their thoughts into "I believe..." or "I operate..." statements that reveal themselves through the conversation</action>
+
+<template-output>agent_persona</template-output>
+</step>
+
+<step n="3" goal="Build capabilities through natural progression">
+<action>Guide user to define what capabilities the agent should have, starting with core commands they've mentioned and then exploring additional possibilities that would complement the agent's purpose</action>
+
+<action>As capabilities emerge, subtly guide toward technical implementation without breaking the conversational flow</action>
+
+<template-output>initial_capabilities</template-output>
+</step>
+
+<step n="4" goal="Refine commands and discover advanced features">
+<critical>Help and Exit are auto-injected; do NOT add them. Triggers are auto-prefixed with * during build.</critical>
+
+<action>Transform their natural language capabilities into technical YAML command structure, explaining the implementation approach as you structure each capability into workflows, actions, or prompts</action>
+
+<action>If they seem engaged, explore whether they'd like to add special prompts for complex analyses or critical setup steps for agent activation</action>
+
+<action>Build the YAML menu structure naturally from the conversation, ensuring each command has proper trigger, workflow/action reference, and description</action>
+
+<example>
+```yaml
+menu:
+  # Commands emerge from discussion
+  - trigger: [emerging from conversation]
+    workflow: [path based on capability]
+    description: [user's words refined]
+```
+</example>
+
+<template-output>agent_commands</template-output>
+</step>
+
+<step n="5" goal="Name the agent at the perfect moment">
+<action>Guide user to name the agent based on everything discovered so far - its purpose, personality, and capabilities, helping them see how the naming naturally emerges from who this agent is</action>
+
+<action>Explore naming options by connecting personality traits, specializations, and communication style to potential names that feel meaningful and appropriate</action>
+
+**Naming Elements:**
+
+- Agent name: Personality-driven (e.g., "Sarah", "Max", "Data Wizard")
+- Agent title: Based on the role discovered earlier
+- Agent icon: Emoji that captures its essence
+- Filename: Auto-suggest based on name (kebab-case)
+
+<action>Present natural suggestions based on the agent's characteristics, letting them choose or create their own since they now know who this agent truly is</action>
+
+<template-output>agent_identity</template-output>
+</step>
+
+<step n="6" goal="Bring it all together">
+<action>Share the journey of what you've created together, summarizing how the agent started with a purpose, discovered its personality traits, gained capabilities, and received its name</action>
+
+<action>Generate the complete YAML incorporating all discovered elements:</action>
+
+<example>
+```yaml
+agent:
+  metadata:
+    id: bmad/{{target_module}}/agents/{{agent_filename}}.md
+    name: {{agent_name}} # The name chosen together
+    title: {{agent_title}} # From the role that emerged
+    icon: {{agent_icon}} # The perfect emoji
+    module: {{target_module}}
+
+persona:
+role: |
+{{The role discovered}}
+identity: |
+{{The background that emerged}}
+communication_style: |
+{{The style they loved}}
+principles: {{The beliefs articulated}}
+
+# Features explored
+
+prompts: {{if discussed}}
+critical_actions: {{if needed}}
+
+menu: {{The capabilities built}}
+
+````
+</example>
+
+<critical>Save based on agent type:</critical>
+- If Module Agent: Save to {module_output_file}
+- If Standalone (Simple/Expert): Save to {standalone_output_file}
+
+<action>Celebrate the completed agent with enthusiasm</action>
+
+<template-output>complete_agent</template-output>
+</step>
+
+<step n="7" goal="Optional personalization" optional="true">
+<ask>Would you like to create a customization file? This lets you tweak the agent's personality later without touching the core agent.</ask>
+
+<check>If interested:</check>
+<action>Explain how the customization file gives them a playground to experiment with different personality traits, add new commands, or adjust responses as they get to know the agent better</action>
+
+<action>Create customization file at: {config_output_file}</action>
+
+<example>
+```yaml
+# Personal tweaks for {{agent_name}}
+# Experiment freely - changes merge at build time
+agent:
+  metadata:
+    name: '' # Try nicknames!
+  persona:
+    role: ''
+    identity: ''
+    communication_style: '' # Switch styles anytime
+    principles: []
+  critical_actions: []
+  prompts: []
+  menu: [] # Add personal commands
+````
+
+</example>
+
+<template-output>agent_config</template-output>
+</step>
+
+<step n="8" goal="Set up the agent's workspace" if="agent_type == 'expert'">
+<action>Guide user through setting up the Expert agent's personal workspace, making it feel like preparing an office with notes, research areas, and data folders</action>
+
+<action>Determine sidecar location based on whether build tools are available (next to agent YAML) or not (in output folder with clear structure)</action>
+
+<action>CREATE the complete sidecar file structure:</action>
+
+**Folder Structure:**
+
+```
+{{agent_filename}}-sidecar/
+├── memories.md         # Persistent memory
+├── instructions.md     # Private directives
+├── knowledge/         # Knowledge base
+│   └── README.md
+└── sessions/          # Session notes
+```
+
+**File: memories.md**
+
+```markdown
+# {{agent_name}}'s Memory Bank
+
+## User Preferences
+
+<!-- Populated as I learn about you -->
+
+## Session History
+
+<!-- Important moments from our interactions -->
+
+## Personal Notes
+
+<!-- My observations and insights -->
+```
+
+**File: instructions.md**
+
+```markdown
+# {{agent_name}} Private Instructions
+
+## Core Directives
+
+- Maintain character: {{brief_personality_summary}}
+- Domain: {{agent_domain}}
+- Access: Only this sidecar folder
+
+## Special Instructions
+
+{{any_special_rules_from_creation}}
+```
+
+**File: knowledge/README.md**
+
+```markdown
+# {{agent_name}}'s Knowledge Base
+
+Add domain-specific resources here.
+```
+
+<action>Update agent YAML to reference sidecar with paths to created files</action>
+<action>Show user the created structure location</action>
+
+<template-output>sidecar_resources</template-output>
+</step>
+
+<step n="8b" goal="Handle build tools availability">
+<action>Check if BMAD build tools are available in this project</action>
+
+<check>If in BMAD-METHOD project with build tools:</check>
+<action>Proceed normally - agent will be built later by the installer</action>
+
+<check>If NO build tools available (external project):</check>
+<ask>Build tools not detected in this project. Would you like me to:
+
+1. Generate the compiled agent (.md with XML) ready to use
+2. Keep the YAML and build it elsewhere
+3. Provide both formats
+   </ask>
+
+<check>If option 1 or 3 selected:</check>
+<action>Generate compiled agent XML with proper structure including activation rules, persona sections, and menu items</action>
+<action>Save compiled version as {{agent_filename}}.md</action>
+<action>Provide path for .claude/commands/ or similar</action>
+
+<template-output>build_handling</template-output>
+</step>
+
+<step n="9" goal="Quality check with personality">
+<action>Run validation conversationally, presenting checks as friendly confirmations while running technical validation behind the scenes</action>
+
+**Conversational Checks:**
+
+- Configuration validation
+- Command functionality verification
+- Personality settings confirmation
+
+<check>If issues found:</check>
+<action>Explain the issue conversationally and fix it</action>
+
+<check>If all good:</check>
+<action>Celebrate that the agent passed all checks and is ready</action>
+
+**Technical Checks (behind the scenes):**
+
+1. YAML structure validity
+2. Menu command validation
+3. Build compilation test
+4. Type-specific requirements
+
+<template-output>validation_results</template-output>
+</step>
+
+<step n="10" goal="Celebrate and guide next steps">
+<action>Celebrate the accomplishment, sharing what type of agent was created with its key characteristics and top capabilities</action>
+
+<action>Guide user through how to activate the agent:</action>
+
+**Activation Instructions:**
+
+1. Run the BMAD Method installer to this project location
+2. Select 'Compile Agents (Quick rebuild of all agent .md files)' after confirming the folder
+3. Call the agent anytime after compilation
+
+**Location Information:**
+
+- Saved location: {{output_file}}
+- Available after compilation in project
+
+**Initial Usage:**
+
+- List the commands available
+- Suggest trying the first command to see it in action
+
+<check>If Expert agent:</check>
+<action>Remind user to add any special knowledge or data the agent might need to its workspace</action>
+
+<action>Explore what user would like to do next - test the agent, create a teammate, or tweak personality</action>
+
+<action>End with enthusiasm in {communication_language}, addressing {user_name}, expressing how the collaboration was enjoyable and the agent will be incredibly helpful for its main purpose</action>
+
+<template-output>completion_message</template-output>
+</step>
+
+</workflow>

bmad/bmb/workflows/create-agent/workflow.yaml

@@ -0,0 +1,35 @@
+# Build Agent Workflow Configuration
+name: create-agent
+description: "Interactive workflow to build BMAD Core compliant agents (YAML source compiled to .md during install) with optional brainstorming, persona development, and command structure"
+author: "BMad"
+
+# Critical variables load from config_source
+config_source: "{project-root}/bmad/bmb/config.yaml"
+custom_agent_location: "{config_source}:custom_agent_location"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+
+# Technical documentation for agent building
+agent_types: "{installed_path}/agent-types.md"
+agent_architecture: "{installed_path}/agent-architecture.md"
+agent_commands: "{installed_path}/agent-command-patterns.md"
+communication_styles: "{installed_path}/communication-styles.md"
+
+# Optional docs that help understand agent patterns
+recommended_inputs:
+  - example_agents: "{project-root}/bmad/bmm/agents/"
+  - agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/create-agent"
+template: false # This is an interactive workflow - no template needed
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Output configuration - YAML agents compiled to .md at install time
+# Module agents: Save to bmad/{{target_module}}/agents/
+# Standalone agents: Save to custom_agent_location/
+module_output_file: "{project-root}/bmad/{{target_module}}/agents/{{agent_filename}}.agent.yaml"
+standalone_output_file: "{custom_agent_location}/{{agent_filename}}.agent.yaml"
+# Optional user override file (auto-created by installer if missing)
+config_output_file: "{project-root}/bmad/_cfg/agents/{{target_module}}-{{agent_filename}}.customize.yaml"

bmad/bmb/workflows/create-module/README.md

@@ -0,0 +1,218 @@
+# Build Module Workflow
+
+## Overview
+
+The Build Module workflow is an interactive scaffolding system that creates complete BMAD modules with agents, workflows, tasks, and installation infrastructure. It serves as the primary tool for building new modules in the BMAD ecosystem, guiding users through the entire module creation process from concept to deployment-ready structure.
+
+## Key Features
+
+- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
+- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
+- **Component Integration** - Seamless integration with create-agent and create-workflow workflows
+- **Installation Infrastructure** - Complete installer setup with configuration templates
+- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
+- **Validation and Documentation** - Built-in validation checks and comprehensive README generation
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow create-module
+```
+
+### With Module Brief Input
+
+```bash
+# If you have a module brief from the module-brief workflow
+workflow create-module --input module-brief-my-module-2024-09-26.md
+```
+
+### Configuration
+
+The workflow loads critical variables from the BMB configuration:
+
+- **custom_module_location**: Where custom modules are created (default: `bmad/`)
+- **user_name**: Module author information
+- **date**: Automatic timestamp for versioning
+
+## Workflow Structure
+
+### Files Included
+
+```
+create-module/
+├── workflow.yaml           # Configuration and metadata
+├── instructions.md         # Step-by-step execution guide
+├── checklist.md           # Validation criteria
+├── module-structure.md    # Module architecture guide
+├── installer-templates/   # Installation templates
+│   ├── install-config.yaml
+│   └── installer.js
+└── README.md             # This file
+```
+
+## Workflow Process
+
+### Phase 1: Concept Definition (Steps 1-2)
+
+**Module Vision and Identity**
+
+- Define module concept, purpose, and target audience
+- Establish module code (kebab-case) and friendly name
+- Choose module category (Domain-Specific, Creative, Technical, Business, Personal)
+- Plan component architecture with agent and workflow specifications
+
+**Module Brief Integration**
+
+- Automatically detects existing module briefs in output folder
+- Can load and use briefs as pre-populated blueprints
+- Accelerates planning when comprehensive brief exists
+
+### Phase 2: Architecture Planning (Steps 3-4)
+
+**Directory Structure Creation**
+
+- Creates complete module directory hierarchy
+- Sets up agent, workflow, task, template, and data folders
+- Establishes installer directory with proper configuration
+
+**Module Configuration**
+
+- Generates main config.yaml with module metadata
+- Configures component counts and references
+- Sets up output and data folder specifications
+
+### Phase 3: Component Creation (Steps 5-6)
+
+**Interactive Component Building**
+
+- Optional creation of first agent using create-agent workflow
+- Optional creation of first workflow using create-workflow workflow
+- Creates placeholders for components to be built later
+
+**Workflow Integration**
+
+- Seamlessly invokes sub-workflows for component creation
+- Ensures proper file placement and structure
+- Maintains module consistency across components
+
+### Phase 4: Installation and Documentation (Steps 7-9)
+
+**Installer Infrastructure**
+
+- Creates install-module-config.yaml for deployment
+- Sets up optional installer.js for complex installation logic
+- Configures post-install messaging and instructions
+
+**Comprehensive Documentation**
+
+- Generates detailed README.md with usage examples
+- Creates development roadmap for remaining components
+- Provides quick commands for continued development
+
+### Phase 5: Validation and Finalization (Step 10)
+
+**Quality Assurance**
+
+- Validates directory structure and configuration files
+- Checks component references and path consistency
+- Ensures installer configuration is deployment-ready
+- Provides comprehensive module summary and next steps
+
+## Output
+
+### Generated Files
+
+- **Module Directory**: Complete module structure at `{project-root}/bmad/{module_code}/`
+- **Configuration Files**: config.yaml, install-module-config.yaml
+- **Documentation**: README.md, TODO.md development roadmap
+- **Component Placeholders**: Structured folders for agents, workflows, and tasks
+
+### Output Structure
+
+The workflow creates a complete module ready for development:
+
+1. **Module Identity** - Name, code, version, and metadata
+2. **Directory Structure** - Proper BMAD module hierarchy
+3. **Configuration System** - Runtime and installation configs
+4. **Component Framework** - Ready-to-use agent and workflow scaffolding
+5. **Installation Infrastructure** - Deployment-ready installer
+6. **Documentation Suite** - README, roadmap, and development guides
+
+## Requirements
+
+- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
+- **BMAD Core Configuration** - Properly configured BMB config.yaml
+- **Build Tools Access** - create-agent and create-workflow workflows must be available
+
+## Best Practices
+
+### Before Starting
+
+1. **Create a Module Brief** - Run module-brief workflow for comprehensive planning
+2. **Review Existing Modules** - Study similar modules in `/bmad/` for patterns and inspiration
+3. **Define Clear Scope** - Have a concrete vision of what the module will accomplish
+
+### During Execution
+
+1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
+2. **Start Simple** - Create one core agent and workflow, then expand iteratively
+3. **Leverage Sub-workflows** - Use create-agent and create-workflow for quality components
+4. **Validate Early** - Review generated structure before proceeding to next phases
+
+### After Completion
+
+1. **Follow the Roadmap** - Use generated TODO.md for systematic development
+2. **Test Installation** - Validate installer with `bmad install {module_code}`
+3. **Iterate Components** - Use quick commands to add agents and workflows
+4. **Document Progress** - Update README.md as the module evolves
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: Module already exists at target location
+
+- **Solution**: Choose a different module code or remove existing module
+- **Check**: Verify output folder permissions and available space
+
+**Issue**: Sub-workflow invocation fails
+
+- **Solution**: Ensure create-agent and create-workflow workflows are available
+- **Check**: Validate workflow paths in config.yaml
+
+**Issue**: Installation configuration invalid
+
+- **Solution**: Review install-module-config.yaml syntax and paths
+- **Check**: Ensure all referenced paths use {project-root} variables correctly
+
+## Customization
+
+To customize this workflow:
+
+1. **Modify Instructions** - Update instructions.md to adjust scaffolding steps
+2. **Extend Templates** - Add new installer templates in installer-templates/
+3. **Update Validation** - Enhance checklist.md with additional quality checks
+4. **Add Components** - Integrate additional sub-workflows for specialized components
+
+## Version History
+
+- **v1.0.0** - Initial release
+  - Interactive module scaffolding
+  - Component integration with create-agent and create-workflow
+  - Complete installation infrastructure
+  - Module brief integration support
+
+## Support
+
+For issues or questions:
+
+- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Study module structure patterns at `module-structure.md`
+- Validate output using `checklist.md`
+- Consult existing modules in `/bmad/` for examples
+
+---
+
+_Part of the BMad Method v5 - BMB (Builder) Module_

bmad/bmb/workflows/create-module/brainstorm-context.md

@@ -0,0 +1,137 @@
+# Module Brainstorming Context
+
+_Context provided to brainstorming workflow when creating a new BMAD module_
+
+## Session Focus
+
+You are brainstorming ideas for a **complete BMAD module** - a self-contained package that extends the BMAD Method with specialized domain expertise and capabilities.
+
+## What is a BMAD Module?
+
+A module is a cohesive package that provides:
+
+- **Domain Expertise**: Specialized knowledge in a specific area (RPG, DevOps, Content Creation, etc.)
+- **Agent Team**: Multiple AI personas with complementary skills
+- **Workflows**: Guided processes for common tasks in the domain
+- **Templates**: Document structures for consistent outputs
+- **Integration**: Components that work together seamlessly
+
+## Brainstorming Goals
+
+Explore and define:
+
+### 1. Domain and Purpose
+
+- **What domain/problem space?** (e.g., game development, marketing, personal productivity)
+- **Who is the target user?** (developers, writers, managers, hobbyists)
+- **What pain points does it solve?** (tedious tasks, missing structure, need for expertise)
+- **What makes this domain exciting?** (creativity, efficiency, empowerment)
+
+### 2. Agent Team Composition
+
+- **How many agents?** (typically 3-7 for a module)
+- **What roles/personas?** (architect, researcher, reviewer, specialist)
+- **How do they collaborate?** (handoffs, reviews, ensemble work)
+- **What personality theme?** (Star Trek crew, superhero team, fantasy party, professional squad)
+
+### 3. Core Workflows
+
+- **What documents need creating?** (plans, specs, reports, creative outputs)
+- **What processes need automation?** (analysis, generation, review, deployment)
+- **What workflows enable the vision?** (3-10 key workflows that define the module)
+
+### 4. Value Proposition
+
+- **What becomes easier?** (specific tasks that get 10x faster)
+- **What becomes possible?** (new capabilities previously unavailable)
+- **What becomes better?** (quality improvements, consistency gains)
+
+## Creative Constraints
+
+A good BMAD module should be:
+
+- **Focused**: Serves a specific domain well (not generic)
+- **Complete**: Provides end-to-end capabilities for that domain
+- **Cohesive**: Agents and workflows complement each other
+- **Fun**: Personality and creativity make it enjoyable to use
+- **Practical**: Solves real problems, delivers real value
+
+## Module Architecture Questions
+
+1. **Module Identity**
+   - Module code (kebab-case, e.g., "rpg-toolkit")
+   - Module name (friendly, e.g., "RPG Toolkit")
+   - Module purpose (one sentence)
+   - Target audience
+
+2. **Agent Lineup**
+   - Agent names and roles
+   - Communication styles and personalities
+   - Expertise areas
+   - Command sets (what each agent can do)
+
+3. **Workflow Portfolio**
+   - Document generation workflows
+   - Action/automation workflows
+   - Analysis/research workflows
+   - Creative/ideation workflows
+
+4. **Integration Points**
+   - How agents invoke workflows
+   - How workflows use templates
+   - How components pass data
+   - Dependencies on other modules
+
+## Example Module Patterns
+
+### Professional Domains
+
+- **DevOps Suite**: Deploy, Monitor, Troubleshoot agents + deployment workflows
+- **Marketing Engine**: Content, SEO, Analytics agents + campaign workflows
+- **Legal Assistant**: Contract, Research, Review agents + document workflows
+
+### Creative Domains
+
+- **RPG Toolkit**: DM, NPC, Quest agents + adventure creation workflows
+- **Story Crafter**: Plot, Character, World agents + writing workflows
+- **Music Producer**: Composer, Arranger, Mixer agents + production workflows
+
+### Personal Domains
+
+- **Life Coach**: Planner, Tracker, Mentor agents + productivity workflows
+- **Learning Companion**: Tutor, Quiz, Reviewer agents + study workflows
+- **Health Guide**: Nutrition, Fitness, Wellness agents + tracking workflows
+
+## Suggested Brainstorming Techniques
+
+Particularly effective for module ideation:
+
+1. **Domain Immersion**: Deep dive into target domain's problems
+2. **Persona Mapping**: Who needs this and what do they struggle with?
+3. **Workflow Mapping**: What processes exist today? How could they improve?
+4. **Team Building**: What personalities would make a great team?
+5. **Integration Thinking**: How do pieces connect and amplify each other?
+
+## Key Questions to Answer
+
+1. What domain expertise should this module embody?
+2. What would users be able to do that they can't do now?
+3. Who are the 3-7 agents and what are their personalities?
+4. What are the 5-10 core workflows?
+5. What makes this module delightful to use?
+6. How is this different from existing tools?
+7. What's the "killer feature" that makes this essential?
+
+## Output Goals
+
+Generate:
+
+- **Module concept**: Clear vision and purpose
+- **Agent roster**: Names, roles, personalities for each agent
+- **Workflow list**: Core workflows with brief descriptions
+- **Unique angle**: What makes this module special
+- **Use cases**: 3-5 concrete scenarios where this module shines
+
+---
+
+_This focused context helps create cohesive, valuable BMAD modules_

bmad/bmb/workflows/create-module/checklist.md

@@ -0,0 +1,245 @@
+# Build Module Validation Checklist
+
+## Module Identity and Metadata
+
+### Basic Information
+
+- [ ] Module code follows kebab-case convention (e.g., "rpg-toolkit")
+- [ ] Module name is descriptive and title-cased
+- [ ] Module purpose is clearly defined (1-2 sentences)
+- [ ] Target audience is identified
+- [ ] Version number follows semantic versioning (e.g., "1.0.0")
+- [ ] Author information is present
+
+### Naming Consistency
+
+- [ ] Module code used consistently throughout all files
+- [ ] No naming conflicts with existing modules
+- [ ] All paths use consistent module code references
+
+## Directory Structure
+
+### Source Directories (bmad/{module-code}/)
+
+- [ ] `/agents` directory created (even if empty)
+- [ ] `/workflows` directory created (even if empty)
+- [ ] `/tasks` directory exists (if tasks planned)
+- [ ] `/templates` directory exists (if templates used)
+- [ ] `/data` directory exists (if data files needed)
+- [ ] `config.yaml` present in module root
+- [ ] `README.md` present with documentation
+
+### Runtime Directories (bmad/{module-code}/)
+
+- [ ] `/_module-installer` directory created
+- [ ] `/data` directory for user data
+- [ ] `/agents` directory for overrides
+- [ ] `/workflows` directory for instances
+- [ ] Runtime `config.yaml` present
+
+## Component Planning
+
+### Agents
+
+- [ ] At least one agent defined or planned
+- [ ] Agent purposes are distinct and clear
+- [ ] Agent types (Simple/Expert/Module) identified
+- [ ] No significant overlap between agents
+- [ ] Primary agent is identified
+
+### Workflows
+
+- [ ] At least one workflow defined or planned
+- [ ] Workflow purposes are clear
+- [ ] Workflow types identified (Document/Action/Interactive)
+- [ ] Primary workflow is identified
+- [ ] Workflow complexity is appropriate
+
+### Tasks (if applicable)
+
+- [ ] Tasks have single, clear purposes
+- [ ] Tasks don't duplicate workflow functionality
+- [ ] Task files follow naming conventions
+
+## Configuration Files
+
+### Module config.yaml
+
+- [ ] All required fields present (name, code, version, author)
+- [ ] Component lists accurate (agents, workflows, tasks)
+- [ ] Paths use proper variables ({project-root}, etc.)
+- [ ] Output folders configured
+- [ ] Custom settings documented
+
+### Install Configuration
+
+- [ ] `install-module-config.yaml` exists in `_module-installer`
+- [ ] Installation steps defined
+- [ ] Directory creation steps present
+- [ ] File copy operations specified
+- [ ] Module registration included
+- [ ] Post-install message defined
+
+## Installation Infrastructure
+
+### Installer Files
+
+- [ ] Install configuration validates against schema
+- [ ] All source paths exist or are marked as templates
+- [ ] Destination paths use correct variables
+- [ ] Optional vs required steps clearly marked
+
+### installer.js (if present)
+
+- [ ] Main `installModule` function exists
+- [ ] Error handling implemented
+- [ ] Console logging for user feedback
+- [ ] Exports correct function names
+- [ ] Placeholder code replaced with actual logic (or logged as TODO)
+
+### External Assets (if any)
+
+- [ ] Asset files exist in assets directory
+- [ ] Copy destinations are valid
+- [ ] Permissions requirements documented
+
+## Documentation
+
+### README.md
+
+- [ ] Module overview section present
+- [ ] Installation instructions included
+- [ ] Component listing with descriptions
+- [ ] Quick start guide provided
+- [ ] Configuration options documented
+- [ ] At least one usage example
+- [ ] Directory structure shown
+- [ ] Author and date information
+
+### Component Documentation
+
+- [ ] Each agent has purpose documentation
+- [ ] Each workflow has description
+- [ ] Tasks are documented (if present)
+- [ ] Examples demonstrate typical usage
+
+### Development Roadmap
+
+- [ ] TODO.md or roadmap section exists
+- [ ] Planned components listed
+- [ ] Development phases identified
+- [ ] Quick commands for adding components
+
+## Integration
+
+### Cross-component References
+
+- [ ] Agents reference correct workflow paths
+- [ ] Workflows reference correct task paths
+- [ ] All internal paths use module variables
+- [ ] External dependencies declared
+
+### Module Boundaries
+
+- [ ] Module scope is well-defined
+- [ ] No feature creep into other domains
+- [ ] Clear separation from other modules
+
+## Quality Checks
+
+### Completeness
+
+- [ ] At least one functional component (not all placeholders)
+- [ ] Core functionality is implementable
+- [ ] Module provides clear value
+
+### Consistency
+
+- [ ] Formatting consistent across files
+- [ ] Variable naming follows conventions
+- [ ] Communication style appropriate for domain
+
+### Scalability
+
+- [ ] Structure supports future growth
+- [ ] Component organization is logical
+- [ ] No hard-coded limits
+
+## Testing and Validation
+
+### Structural Validation
+
+- [ ] YAML files parse without errors
+- [ ] JSON files (if any) are valid
+- [ ] XML files (if any) are well-formed
+- [ ] No syntax errors in JavaScript files
+
+### Path Validation
+
+- [ ] All referenced paths exist or are clearly marked as TODO
+- [ ] Variable substitutions are correct
+- [ ] No absolute paths (unless intentional)
+
+### Installation Testing
+
+- [ ] Installation steps can be simulated
+- [ ] No circular dependencies
+- [ ] Uninstall process defined (if complex)
+
+## Final Checks
+
+### Ready for Use
+
+- [ ] Module can be installed without errors
+- [ ] At least one component is functional
+- [ ] User can understand how to get started
+- [ ] Next steps are clear
+
+### Professional Quality
+
+- [ ] No placeholder text remains (unless marked TODO)
+- [ ] No obvious typos or grammar issues
+- [ ] Professional tone throughout
+- [ ] Contact/support information provided
+
+## Issues Found
+
+### Critical Issues
+
+<!-- List any issues that MUST be fixed before module can be used -->
+
+### Warnings
+
+<!-- List any issues that should be addressed but won't prevent basic usage -->
+
+### Improvements
+
+<!-- List any optional enhancements that would improve the module -->
+
+### Missing Components
+
+<!-- List any planned components not yet implemented -->
+
+## Module Complexity Assessment
+
+### Complexity Rating
+
+- [ ] Simple (1-2 agents, 2-3 workflows)
+- [ ] Standard (3-5 agents, 5-10 workflows)
+- [ ] Complex (5+ agents, 10+ workflows)
+
+### Readiness Level
+
+- [ ] Prototype (Basic structure, mostly placeholders)
+- [ ] Alpha (Core functionality works)
+- [ ] Beta (Most features complete, needs testing)
+- [ ] Release (Full functionality, documented)
+
+## Sign-off
+
+**Module Name:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
+**Module Code:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
+**Version:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
+**Validated By:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
+**Date:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
+**Status:** ⬜ Pass / ⬜ Pass with Issues / ⬜ Fail

bmad/bmb/workflows/create-module/installer-templates/install-module-config.yaml

@@ -0,0 +1,132 @@
+# {{MODULE_NAME}} Installation Configuration Template
+# This file defines how the module gets installed into a BMAD system
+
+module_name: "{{MODULE_NAME}}"
+module_code: "{{MODULE_CODE}}"
+author: "{{AUTHOR}}"
+installation_date: "{{DATE}}"
+bmad_version_required: "6.0.0"
+
+# Module metadata
+metadata:
+  description: "{{MODULE_DESCRIPTION}}"
+  category: "{{MODULE_CATEGORY}}"
+  tags: ["{{MODULE_TAGS}}"]
+  homepage: "{{MODULE_HOMEPAGE}}"
+  license: "{{MODULE_LICENSE}}"
+
+# Pre-installation checks
+pre_install_checks:
+  - name: "Check BMAD version"
+    type: "version_check"
+    minimum: "6.0.0"
+
+  - name: "Check dependencies"
+    type: "module_check"
+    required_modules: [] # List any required modules
+
+  - name: "Check disk space"
+    type: "disk_check"
+    required_mb: 50
+
+# Installation steps
+install_steps:
+  - name: "Create module directories"
+    action: "mkdir"
+    paths:
+      - "{project-root}/bmad/{{MODULE_CODE}}"
+      - "{project-root}/bmad/{{MODULE_CODE}}/data"
+      - "{project-root}/bmad/{{MODULE_CODE}}/agents"
+      - "{project-root}/bmad/{{MODULE_CODE}}/workflows"
+      - "{project-root}/bmad/{{MODULE_CODE}}/config"
+      - "{project-root}/bmad/{{MODULE_CODE}}/logs"
+
+  - name: "Copy module configuration"
+    action: "copy"
+    files:
+      - source: "config.yaml"
+        dest: "{project-root}/bmad/{{MODULE_CODE}}/config.yaml"
+
+  - name: "Copy default data files"
+    action: "copy"
+    optional: true
+    files:
+      - source: "data/*"
+        dest: "{project-root}/bmad/{{MODULE_CODE}}/data/"
+
+  - name: "Register module in manifest"
+    action: "register"
+    manifest_path: "{project-root}/bmad/_cfg/manifest.yaml"
+    entry:
+      module: "{{MODULE_CODE}}"
+      status: "active"
+      path: "{project-root}/bmad/{{MODULE_CODE}}"
+
+  - name: "Setup agent shortcuts"
+    action: "create_shortcuts"
+    agents: "{{AGENT_LIST}}"
+
+  - name: "Initialize module database"
+    action: "exec"
+    optional: true
+    script: "installer.js"
+    function: "initDatabase"
+
+# External assets to install
+external_assets:
+  - description: "Module documentation"
+    source: "assets/docs/*"
+    dest: "{project-root}/docs/{{MODULE_CODE}}/"
+
+  - description: "Example configurations"
+    source: "assets/examples/*"
+    dest: "{project-root}/examples/{{MODULE_CODE}}/"
+    optional: true
+
+# Module configuration defaults
+default_config:
+  output_folder: "{project-root}/output/{{MODULE_CODE}}"
+  data_folder: "{project-root}/bmad/{{MODULE_CODE}}/data"
+  log_level: "info"
+  auto_save: true
+  # {{CUSTOM_CONFIG}}
+
+# Post-installation setup
+post_install:
+  - name: "Run initial setup"
+    action: "workflow"
+    workflow: "{{MODULE_CODE}}-setup"
+    optional: true
+
+  - name: "Generate sample data"
+    action: "exec"
+    script: "installer.js"
+    function: "generateSamples"
+    optional: true
+
+  - name: "Verify installation"
+    action: "test"
+    test_command: "bmad test {{MODULE_CODE}}"
+
+# Post-installation message
+post_install_message: |
+  ✅ {{MODULE_NAME}} has been installed successfully!
+
+  🚀 Quick Start:
+  1. Load the main agent: `agent {{PRIMARY_AGENT}}`
+  2. View available commands: `*help`
+  3. Run the main workflow: `workflow {{PRIMARY_WORKFLOW}}`
+
+  📚 Documentation: {project-root}/docs/{{MODULE_CODE}}/README.md
+  💡 Examples: {project-root}/examples/{{MODULE_CODE}}/
+
+  {{CUSTOM_MESSAGE}}
+
+# Uninstall configuration
+uninstall:
+  preserve_user_data: true
+  remove_paths:
+    - "{project-root}/bmad/{{MODULE_CODE}}"
+    - "{project-root}/docs/{{MODULE_CODE}}"
+  backup_before_remove: true
+  unregister_from_manifest: true

bmad/bmb/workflows/create-module/installer-templates/installer.js

@@ -0,0 +1,231 @@
+/* eslint-disable unicorn/prefer-module, unicorn/prefer-node-protocol */
+/**
+ * {{MODULE_NAME}} Module Installer
+ * Custom installation logic for complex module setup
+ *
+ * This is a template - replace {{VARIABLES}} with actual values
+ */
+
+// const fs = require('fs'); // Uncomment when implementing file operations
+const path = require('path');
+
+/**
+ * Main installation function
+ * Called by BMAD installer when processing the module
+ */
+async function installModule(config) {
+  console.log('🚀 Installing {{MODULE_NAME}} module...');
+  console.log(`   Version: ${config.version}`);
+  console.log(`   Module Code: ${config.module_code}`);
+
+  try {
+    // Step 1: Validate environment
+    await validateEnvironment(config);
+
+    // Step 2: Setup custom configurations
+    await setupConfigurations(config);
+
+    // Step 3: Initialize module-specific features
+    await initializeFeatures(config);
+
+    // Step 4: Run post-install tasks
+    await runPostInstallTasks(config);
+
+    console.log('✅ {{MODULE_NAME}} module installed successfully!');
+    return {
+      success: true,
+      message: 'Module installed and configured',
+    };
+  } catch (error) {
+    console.error('❌ Installation failed:', error.message);
+    return {
+      success: false,
+      error: error.message,
+    };
+  }
+}
+
+/**
+ * Validate that the environment meets module requirements
+ */
+async function validateEnvironment(config) {
+  console.log('   Validating environment...');
+
+  // TODO: Add environment checks
+  // Examples:
+  // - Check for required tools/binaries
+  // - Verify permissions
+  // - Check network connectivity
+  // - Validate API keys
+
+  // Placeholder validation
+  if (!config.project_root) {
+    throw new Error('Project root not defined');
+  }
+
+  console.log('   ✓ Environment validated');
+}
+
+/**
+ * Setup module-specific configurations
+ */
+async function setupConfigurations(config) {
+  console.log('   Setting up configurations...');
+
+  // TODO: Add configuration setup
+  // Examples:
+  // - Create config files
+  // - Setup environment variables
+  // - Configure external services
+  // - Initialize settings
+
+  // Placeholder configuration
+  const configPath = path.join(config.project_root, 'bmad', config.module_code, 'config.json');
+
+  // Example of module config that would be created
+  // const moduleConfig = {
+  //   installed: new Date().toISOString(),
+  //   settings: {
+  //     // Add default settings
+  //   }
+  // };
+
+  // Note: This is a placeholder - actual implementation would write the file
+  console.log(`   ✓ Would create config at: ${configPath}`);
+  console.log('   ✓ Configurations complete');
+}
+
+/**
+ * Initialize module-specific features
+ */
+async function initializeFeatures(config) {
+  console.log('   Initializing features...');
+
+  // TODO: Add feature initialization
+  // Examples:
+  // - Create database schemas
+  // - Setup cron jobs
+  // - Initialize caches
+  // - Register webhooks
+  // - Setup file watchers
+
+  // Module-specific initialization based on type
+  switch (config.module_category) {
+    case 'data': {
+      await initializeDataFeatures(config);
+      break;
+    }
+    case 'automation': {
+      await initializeAutomationFeatures(config);
+      break;
+    }
+    case 'integration': {
+      await initializeIntegrationFeatures(config);
+      break;
+    }
+    default: {
+      console.log('   - Using standard initialization');
+    }
+  }
+
+  console.log('   ✓ Features initialized');
+}
+
+/**
+ * Initialize data-related features
+ */
+async function initializeDataFeatures(/* config */) {
+  console.log('   - Setting up data storage...');
+  // TODO: Setup databases, data folders, etc.
+}
+
+/**
+ * Initialize automation features
+ */
+async function initializeAutomationFeatures(/* config */) {
+  console.log('   - Setting up automation hooks...');
+  // TODO: Setup triggers, watchers, schedulers
+}
+
+/**
+ * Initialize integration features
+ */
+async function initializeIntegrationFeatures(/* config */) {
+  console.log('   - Setting up integrations...');
+  // TODO: Configure APIs, webhooks, external services
+}
+
+/**
+ * Run post-installation tasks
+ */
+async function runPostInstallTasks(/* config */) {
+  console.log('   Running post-install tasks...');
+
+  // TODO: Add post-install tasks
+  // Examples:
+  // - Generate sample data
+  // - Run initial workflows
+  // - Send notifications
+  // - Update registries
+
+  console.log('   ✓ Post-install tasks complete');
+}
+
+/**
+ * Initialize database for the module (optional)
+ */
+async function initDatabase(/* config */) {
+  console.log('   Initializing database...');
+
+  // TODO: Add database initialization
+  // This function can be called from install-module-config.yaml
+
+  console.log('   ✓ Database initialized');
+}
+
+/**
+ * Generate sample data for the module (optional)
+ */
+async function generateSamples(config) {
+  console.log('   Generating sample data...');
+
+  // TODO: Create sample files, data, configurations
+  // This helps users understand how to use the module
+
+  const samplesPath = path.join(config.project_root, 'examples', config.module_code);
+
+  console.log(`   - Would create samples at: ${samplesPath}`);
+  console.log('   ✓ Samples generated');
+}
+
+/**
+ * Uninstall the module (cleanup)
+ */
+async function uninstallModule(/* config */) {
+  console.log('🗑️  Uninstalling {{MODULE_NAME}} module...');
+
+  try {
+    // TODO: Add cleanup logic
+    // - Remove configurations
+    // - Clean up databases
+    // - Unregister services
+    // - Backup user data
+
+    console.log('✅ Module uninstalled successfully');
+    return { success: true };
+  } catch (error) {
+    console.error('❌ Uninstall failed:', error.message);
+    return {
+      success: false,
+      error: error.message,
+    };
+  }
+}
+
+// Export functions for BMAD installer
+module.exports = {
+  installModule,
+  initDatabase,
+  generateSamples,
+  uninstallModule,
+};

bmad/bmb/workflows/create-module/instructions.md

@@ -0,0 +1,521 @@
+# Build Module - Interactive Module Builder Instructions
+
+<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
+<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/create-module/workflow.yaml</critical>
+<critical>Study existing modules in: {project-root}/bmad/ for patterns</critical>
+<critical>Communicate in {communication_language} throughout the module creation process</critical>
+
+<workflow>
+
+<step n="-1" goal="Optional brainstorming for module ideas" optional="true">
+<ask>Do you want to brainstorm module ideas first? [y/n]</ask>
+
+<check>If yes:</check>
+<action>Invoke brainstorming workflow: {brainstorming_workflow}</action>
+<action>Pass context data: {brainstorming_context}</action>
+<action>Wait for brainstorming session completion</action>
+<action>Use brainstorming output to inform module concept, agent lineup, and workflow portfolio in following steps</action>
+
+<check>If no:</check>
+<action>Proceed directly to Step 0</action>
+
+<template-output>brainstorming_results</template-output>
+</step>
+
+<step n="0" goal="Check for module brief" optional="true">
+<ask>Do you have a module brief or should we create one? [have/create/skip]</ask>
+
+<check>If create:</check>
+<action>Invoke module-brief workflow: {project-root}/bmad/bmb/workflows/module-brief/workflow.yaml</action>
+<action>Wait for module brief completion</action>
+<action>Load the module brief to use as blueprint</action>
+
+<check>If have:</check>
+<ask>Provide path to module brief document</ask>
+<action>Load the module brief and use it to pre-populate all planning sections</action>
+
+<check>If skip:</check>
+<action>Proceed directly to Step 1</action>
+
+<template-output>module_brief</template-output>
+</step>
+
+<step n="1" goal="Define module concept and scope">
+<critical>Load and study the complete module structure guide</critical>
+<action>Load module structure guide: {module_structure_guide}</action>
+<action>Understand module types (Simple/Standard/Complex)</action>
+<action>Review directory structures and component guidelines</action>
+<action>Study the installation infrastructure patterns</action>
+
+<action>If brainstorming or module brief was completed, reference those results to guide the conversation</action>
+
+<action>Guide user to articulate their module's vision, exploring its purpose, what it will help with, and who will use it</action>
+
+<action>Based on their description, intelligently propose module details:</action>
+
+**Module Identity Development:**
+
+1. **Module name** - Extract from their description with proper title case
+2. **Module code** - Generate kebab-case from name following patterns:
+   - Multi-word descriptive names → shortened kebab-case
+   - Domain-specific terms → recognizable abbreviations
+   - Present suggested code and confirm it works for paths like bmad/{{code}}/agents/
+3. **Module purpose** - Refine their description into 1-2 clear sentences
+4. **Target audience** - Infer from context or ask if unclear
+
+**Module Theme Reference Categories:**
+
+- Domain-Specific (Legal, Medical, Finance, Education)
+- Creative (RPG/Gaming, Story Writing, Music Production)
+- Technical (DevOps, Testing, Architecture, Security)
+- Business (Project Management, Marketing, Sales)
+- Personal (Journaling, Learning, Productivity)
+
+<critical>Determine output location:</critical>
+
+- Module will be created at {installer_output_folder}
+
+<action>Store module identity for scaffolding</action>
+
+<template-output>module_identity</template-output>
+</step>
+
+<step n="2" goal="Plan module components">
+<action>Based on the module purpose, intelligently propose an initial component architecture</action>
+
+**Agents Planning:**
+
+<action>Suggest agents based on module purpose, considering agent types (Simple/Expert/Module) appropriate to each role</action>
+
+**Example Agent Patterns by Domain:**
+
+- Data/Analytics: Analyst, Designer, Builder roles
+- Gaming/Creative: Game Master, Generator, Storytelling roles
+- Team/Business: Manager, Facilitator, Documentation roles
+
+<action>Present suggested agent list with types, explaining we can start with core ones and add others later</action>
+<action>Confirm which agents resonate with their vision</action>
+
+**Workflows Planning:**
+
+<action>Intelligently suggest workflows that complement the proposed agents</action>
+
+**Example Workflow Patterns by Domain:**
+
+- Data/Analytics: analyze-dataset, create-dashboard, generate-report
+- Gaming/Creative: session-prep, generate-encounter, world-building
+- Team/Business: planning, facilitation, documentation workflows
+
+<action>For each workflow, note whether it should be Document, Action, or Interactive type</action>
+<action>Confirm which workflows are most important to start with</action>
+<action>Determine which to create now vs placeholder</action>
+
+**Tasks Planning (optional):**
+<ask>Any special tasks that don't warrant full workflows?</ask>
+
+<check>If tasks needed:</check>
+<action>For each task, capture name, purpose, and whether standalone or supporting</action>
+
+<template-output>module_components</template-output>
+</step>
+
+<step n="2b" goal="Determine module complexity">
+<action>Based on components, intelligently determine module type using criteria:</action>
+
+**Simple Module Criteria:**
+
+- 1-2 agents, all Simple type
+- 1-3 workflows
+- No complex integrations
+
+**Standard Module Criteria:**
+
+- 2-4 agents with mixed types
+- 3-8 workflows
+- Some shared resources
+
+**Complex Module Criteria:**
+
+- 4+ agents or multiple Module-type agents
+- 8+ workflows
+- Complex interdependencies
+- External integrations
+
+<action>Present determined module type with explanation of what structure will be set up</action>
+
+<template-output>module_type</template-output>
+</step>
+
+<step n="3" goal="Create module directory structure">
+<critical>Use module path determined in Step 1:</critical>
+- The module base path is {{module_path}}
+
+<action>Create base module directories at the determined path:</action>
+
+```
+{{module_code}}/
+├── agents/           # Agent definitions
+├── workflows/        # Workflow folders
+├── tasks/           # Task files (if any)
+├── templates/       # Shared templates
+├── data/           # Module data files
+├── config.yaml     # Module configuration
+└── README.md       # Module documentation
+```
+
+<action>Create installer directory:</action>
+
+```
+{{module_code}}/
+├── _module-installer/
+│   ├── install-module-config.yaml
+│   ├── installer.js (optional)
+│   └── assets/     # Files to copy during install
+├── config.yaml     # Runtime configuration
+├── agents/         # Agent configs (optional)
+├── workflows/      # Workflow instances
+└── data/          # User data directory
+```
+
+<template-output>directory_structure</template-output>
+</step>
+
+<step n="4" goal="Generate module configuration">
+Create the main module config.yaml:
+
+```yaml
+# {{module_name}} Module Configuration
+module_name: {{module_name}}
+module_code: {{module_code}}
+author: {{user_name}}
+description: {{module_purpose}}
+
+# Module paths
+module_root: "{project-root}/bmad/{{module_code}}"
+installer_path: "{project-root}/bmad/{{module_code}}"
+
+# Component counts
+agents:
+  count: {{agent_count}}
+  list: {{agent_list}}
+
+workflows:
+  count: {{workflow_count}}
+  list: {{workflow_list}}
+
+tasks:
+  count: {{task_count}}
+  list: {{task_list}}
+
+# Module-specific settings
+{{custom_settings}}
+
+# Output configuration
+output_folder: "{project-root}/docs/{{module_code}}"
+data_folder: "{{determined_module_path}}/data"
+```
+
+<critical>Save location:</critical>
+
+- Save to {{module_path}}/config.yaml
+
+<template-output>module_config</template-output>
+</step>
+
+<step n="5" goal="Create first agent" optional="true">
+<ask>Create your first agent now? [yes/no]</ask>
+
+<check>If yes:</check>
+<action>Invoke agent builder workflow: {agent_builder}</action>
+<action>Pass module_components as context input</action>
+<action>Guide them to create the primary agent for the module</action>
+
+<critical>Save to module's agents folder:</critical>
+
+- Save to {{module_path}}/agents/
+
+<check>If no:</check>
+<action>Create placeholder file in agents folder with TODO notes including agent name, purpose, and type</action>
+
+<template-output>first_agent</template-output>
+</step>
+
+<step n="6" goal="Create first workflow" optional="true">
+<ask>Create your first workflow now? [yes/no]</ask>
+
+<check>If yes:</check>
+<action>Invoke workflow builder: {workflow_builder}</action>
+<action>Pass module_components as context input</action>
+<action>Guide them to create the primary workflow</action>
+
+<critical>Save to module's workflows folder:</critical>
+
+- Save to {{module_path}}/workflows/
+
+<check>If no:</check>
+<action>Create placeholder workflow folder structure with TODO notes for workflow.yaml, instructions.md, and template.md if document workflow</action>
+
+<template-output>first_workflow</template-output>
+</step>
+
+<step n="7" goal="Setup module installer">
+<action>Load installer templates from: {installer_templates}</action>
+
+Create install-module-config.yaml:
+
+```yaml
+# {{module_name}} Installation Configuration
+module_name: { { module_name } }
+module_code: { { module_code } }
+installation_date: { { date } }
+
+# Installation steps
+install_steps:
+  - name: 'Create directories'
+    action: 'mkdir'
+    paths:
+      - '{project-root}/bmad/{{module_code}}'
+      - '{project-root}/bmad/{{module_code}}/data'
+      - '{project-root}/bmad/{{module_code}}/agents'
+
+  - name: 'Copy configuration'
+    action: 'copy'
+    source: '{installer_path}/config.yaml'
+    dest: '{project-root}/bmad/{{module_code}}/config.yaml'
+
+  - name: 'Register module'
+    action: 'register'
+    manifest: '{project-root}/bmad/_cfg/manifest.yaml'
+
+# External assets (if any)
+external_assets:
+  - description: '{{asset_description}}'
+    source: 'assets/{{filename}}'
+    dest: '{{destination_path}}'
+
+# Post-install message
+post_install_message: |
+  {{module_name}} has been installed successfully!
+
+  To get started:
+  1. Load any {{module_code}} agent
+  2. Use *help to see available commands
+  3. Check README.md for full documentation
+```
+
+Create installer.js stub (optional):
+
+```javascript
+// {{module_name}} Module Installer
+// This is a placeholder for complex installation logic
+
+function installModule(config) {
+  console.log('Installing {{module_name}} module...');
+
+  // TODO: Add any complex installation logic here
+  // Examples:
+  // - Database setup
+  // - API key configuration
+  // - External service registration
+  // - File system preparation
+
+  console.log('{{module_name}} module installed successfully!');
+  return true;
+}
+
+module.exports = { installModule };
+```
+
+<template-output>installer_config</template-output>
+</step>
+
+<step n="8" goal="Create module documentation">
+Generate comprehensive README.md:
+
+````markdown
+# {{module_name}}
+
+{{module_purpose}}
+
+## Overview
+
+This module provides:
+{{component_summary}}
+
+## Installation
+
+```bash
+bmad install {{module_code}}
+```
+````
+
+## Components
+
+### Agents ({{agent_count}})
+
+{{agent_documentation}}
+
+### Workflows ({{workflow_count}})
+
+{{workflow_documentation}}
+
+### Tasks ({{task_count}})
+
+{{task_documentation}}
+
+## Quick Start
+
+1. **Load the main agent:**
+
+   ```
+   agent {{primary_agent}}
+   ```
+
+2. **View available commands:**
+
+   ```
+   *help
+   ```
+
+3. **Run the main workflow:**
+   ```
+   workflow {{primary_workflow}}
+   ```
+
+## Module Structure
+
+```
+{{directory_tree}}
+```
+
+## Configuration
+
+The module can be configured in `bmad/{{module_code}}/config.yaml`
+
+Key settings:
+{{configuration_options}}
+
+## Examples
+
+### Example 1: {{example_use_case}}
+
+{{example_walkthrough}}
+
+## Development Roadmap
+
+- [ ] {{roadmap_item_1}}
+- [ ] {{roadmap_item_2}}
+- [ ] {{roadmap_item_3}}
+
+## Contributing
+
+To extend this module:
+
+1. Add new agents using `create-agent` workflow
+2. Add new workflows using `create-workflow` workflow
+3. Submit improvements via pull request
+
+## Author
+
+Created by {{user_name}} on {{date}}
+
+````
+
+<template-output>module_readme</template-output>
+</step>
+
+<step n="9" goal="Generate component roadmap">
+Create a development roadmap for remaining components:
+
+**TODO.md file:**
+```markdown
+# {{module_name}} Development Roadmap
+
+## Phase 1: Core Components
+{{phase1_tasks}}
+
+## Phase 2: Enhanced Features
+{{phase2_tasks}}
+
+## Phase 3: Polish and Integration
+{{phase3_tasks}}
+
+## Quick Commands
+
+Create new agent:
+````
+
+workflow create-agent
+
+```
+
+Create new workflow:
+```
+
+workflow create-workflow
+
+```
+
+## Notes
+{{development_notes}}
+```
+
+Ask if user wants to:
+
+1. Continue building more components now
+2. Save roadmap for later development
+3. Test what's been built so far
+
+<template-output>development_roadmap</template-output>
+</step>
+
+<step n="10" goal="Validate and finalize module">
+<action>Run validation checks:</action>
+
+**Structure validation:**
+
+- All required directories created
+- Config files properly formatted
+- Installer configuration valid
+
+**Component validation:**
+
+- At least one agent or workflow exists (or planned)
+- All references use correct paths
+- Module code consistent throughout
+
+**Documentation validation:**
+
+- README.md complete
+- Installation instructions clear
+- Examples provided
+
+<action>Present summary to {user_name}:</action>
+
+- Module name and code
+- Location path
+- Agent count (created vs planned)
+- Workflow count (created vs planned)
+- Task count
+- Installer status
+
+<action>Provide next steps guidance:</action>
+
+1. Complete remaining components using roadmap
+2. Run the BMAD Method installer to this project location
+3. Select 'Compile Agents' option after confirming folder
+4. Module will be compiled and available for use
+5. Test with bmad install command
+6. Share or integrate with existing system
+
+<ask>Would you like to:
+
+- Create another component now?
+- Test the module installation?
+- Exit and continue later?
+  </ask>
+
+<template-output>module_summary</template-output>
+</step>
+
+</workflow>

bmad/bmb/workflows/create-module/module-structure.md

@@ -0,0 +1,310 @@
+# BMAD Module Structure Guide
+
+## What is a Module?
+
+A BMAD module is a self-contained package of agents, workflows, tasks, and resources that work together to provide specialized functionality. Think of it as an expansion pack for the BMAD Method.
+
+## Module Architecture
+
+### Core Structure
+
+```
+project-root/
+├── bmad/{module-code}/     # Source code
+│   ├── agents/                    # Agent definitions
+│   ├── workflows/                 # Workflow folders
+│   ├── tasks/                     # Task files
+│   ├── templates/                 # Shared templates
+│   ├── data/                      # Static data
+│   ├── config.yaml                # Module config
+│   └── README.md                  # Documentation
+│
+└── bmad/{module-code}/            # Runtime instance
+    ├── _module-installer/         # Installation files
+    │   ├── install-module-config.yaml
+    │   ├── installer.js          # Optional
+    │   └── assets/               # Install assets
+    ├── config.yaml               # User config
+    ├── agents/                   # Agent overrides
+    ├── workflows/                # Workflow instances
+    └── data/                     # User data
+
+```
+
+## Module Types by Complexity
+
+### Simple Module (1-2 agents, 2-3 workflows)
+
+Perfect for focused, single-purpose tools.
+
+**Example: Code Review Module**
+
+- 1 Reviewer Agent
+- 2 Workflows: quick-review, deep-review
+- Clear, narrow scope
+
+### Standard Module (3-5 agents, 5-10 workflows)
+
+Comprehensive solution for a domain.
+
+**Example: Project Management Module**
+
+- PM Agent, Scrum Master Agent, Analyst Agent
+- Workflows: sprint-planning, retrospective, roadmap, user-stories
+- Integrated component ecosystem
+
+### Complex Module (5+ agents, 10+ workflows)
+
+Full platform or framework.
+
+**Example: RPG Toolkit Module**
+
+- DM Agent, NPC Agent, Monster Agent, Loot Agent, Map Agent
+- 15+ workflows for every aspect of game management
+- Multiple interconnected systems
+
+## Module Naming Conventions
+
+### Module Code (kebab-case)
+
+- `data-viz` - Data Visualization
+- `team-collab` - Team Collaboration
+- `rpg-toolkit` - RPG Toolkit
+- `legal-assist` - Legal Assistant
+
+### Module Name (Title Case)
+
+- "Data Visualization Suite"
+- "Team Collaboration Platform"
+- "RPG Game Master Toolkit"
+- "Legal Document Assistant"
+
+## Component Guidelines
+
+### Agents per Module
+
+**Recommended Distribution:**
+
+- **Primary Agent (1)**: The main interface/orchestrator
+- **Specialist Agents (2-4)**: Domain-specific experts
+- **Utility Agents (0-2)**: Helper/support functions
+
+**Anti-patterns to Avoid:**
+
+- Too many overlapping agents
+- Agents that could be combined
+- Agents without clear purpose
+
+### Workflows per Module
+
+**Categories:**
+
+- **Core Workflows (2-3)**: Essential functionality
+- **Feature Workflows (3-5)**: Specific capabilities
+- **Utility Workflows (2-3)**: Supporting operations
+- **Admin Workflows (0-2)**: Maintenance/config
+
+**Workflow Complexity Guide:**
+
+- Simple: 3-5 steps, single output
+- Standard: 5-10 steps, multiple outputs
+- Complex: 10+ steps, conditional logic, sub-workflows
+
+### Tasks per Module
+
+Tasks should be used for:
+
+- Single-operation utilities
+- Shared subroutines
+- Quick actions that don't warrant workflows
+
+## Module Dependencies
+
+### Internal Dependencies
+
+- Agents can reference module workflows
+- Workflows can invoke module tasks
+- Tasks can use module templates
+
+### External Dependencies
+
+- Reference other modules via full paths
+- Declare dependencies in config.yaml
+- Version compatibility notes
+
+## Installation Infrastructure
+
+### Required: install-module-config.yaml
+
+```yaml
+module_name: 'Module Name'
+module_code: 'module-code'
+
+install_steps:
+  - name: 'Create directories'
+    action: 'mkdir'
+    paths: [...]
+
+  - name: 'Copy files'
+    action: 'copy'
+    mappings: [...]
+
+  - name: 'Register module'
+    action: 'register'
+```
+
+### Optional: installer.js
+
+For complex installations requiring:
+
+- Database setup
+- API configuration
+- System integration
+- Permission management
+
+### Optional: External Assets
+
+Files that get copied outside the module:
+
+- System configurations
+- User templates
+- Shared resources
+- Integration scripts
+
+## Module Lifecycle
+
+### Development Phases
+
+1. **Planning Phase**
+   - Define scope and purpose
+   - Identify components
+   - Design architecture
+
+2. **Scaffolding Phase**
+   - Create directory structure
+   - Generate configurations
+   - Setup installer
+
+3. **Building Phase**
+   - Create agents incrementally
+   - Build workflows progressively
+   - Add tasks as needed
+
+4. **Testing Phase**
+   - Test individual components
+   - Verify integration
+   - Validate installation
+
+5. **Deployment Phase**
+   - Package module
+   - Document usage
+   - Distribute/share
+
+## Best Practices
+
+### Module Cohesion
+
+- All components should relate to module theme
+- Clear boundaries between modules
+- No feature creep
+
+### Progressive Enhancement
+
+- Start with MVP (1 agent, 2 workflows)
+- Add components based on usage
+- Refactor as patterns emerge
+
+### Documentation Standards
+
+- Every module needs README.md
+- Each agent needs purpose statement
+- Workflows need clear descriptions
+- Include examples and quickstart
+
+### Naming Consistency
+
+- Use module code prefix for uniqueness
+- Consistent naming patterns within module
+- Clear, descriptive names
+
+## Example Modules
+
+### Example 1: Personal Productivity
+
+```
+productivity/
+├── agents/
+│   ├── task-manager.md      # GTD methodology
+│   └── focus-coach.md        # Pomodoro timer
+├── workflows/
+│   ├── daily-planning/       # Morning routine
+│   ├── weekly-review/        # Week retrospective
+│   └── project-setup/        # New project init
+└── config.yaml
+```
+
+### Example 2: Content Creation
+
+```
+content/
+├── agents/
+│   ├── writer.md            # Blog/article writer
+│   ├── editor.md            # Copy editor
+│   └── seo-optimizer.md     # SEO specialist
+├── workflows/
+│   ├── blog-post/           # Full blog creation
+│   ├── social-media/        # Social content
+│   ├── email-campaign/      # Email sequence
+│   └── content-calendar/    # Planning
+└── templates/
+    ├── blog-template.md
+    └── email-template.md
+```
+
+### Example 3: DevOps Automation
+
+```
+devops/
+├── agents/
+│   ├── deploy-master.md     # Deployment orchestrator
+│   ├── monitor.md           # System monitoring
+│   ├── incident-responder.md # Incident management
+│   └── infra-architect.md   # Infrastructure design
+├── workflows/
+│   ├── ci-cd-setup/         # Pipeline creation
+│   ├── deploy-app/          # Application deployment
+│   ├── rollback/            # Emergency rollback
+│   ├── health-check/        # System verification
+│   └── incident-response/   # Incident handling
+├── tasks/
+│   ├── check-status.md      # Quick status check
+│   └── notify-team.md       # Team notifications
+└── data/
+    └── runbooks/            # Operational guides
+```
+
+## Module Evolution Pattern
+
+```
+Simple Module → Standard Module → Complex Module → Module Suite
+     (MVP)          (Enhanced)        (Complete)      (Ecosystem)
+```
+
+## Common Pitfalls
+
+1. **Over-engineering**: Starting too complex
+2. **Under-planning**: No clear architecture
+3. **Poor boundaries**: Module does too much
+4. **Weak integration**: Components don't work together
+5. **Missing docs**: No clear usage guide
+
+## Success Metrics
+
+A well-designed module has:
+
+- ✅ Clear, focused purpose
+- ✅ Cohesive components
+- ✅ Smooth installation
+- ✅ Comprehensive docs
+- ✅ Room for growth
+- ✅ Happy users!

bmad/bmb/workflows/create-module/workflow.yaml

@@ -0,0 +1,40 @@
+# Build Module Workflow Configuration
+name: create-module
+description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
+author: "BMad"
+
+# Critical variables load from config_source
+config_source: "{project-root}/bmad/bmb/config.yaml"
+custom_module_location: "{config_source}:custom_module_location"
+communication_language: "{config_source}:communication_language"
+user_name: "{config_source}:user_name"
+
+# Reference guides for module building
+module_structure_guide: "{installed_path}/module-structure.md"
+installer_templates: "{installed_path}/installer-templates/"
+
+# Use existing build workflows
+agent_builder: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
+workflow_builder: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
+brainstorming_workflow: "{project-root}/bmad/core/workflows/brainstorming/workflow.yaml"
+brainstorming_context: "{installed_path}/brainstorm-context.md"
+
+# Optional docs that help understand module patterns
+recommended_inputs:
+  - module_brief: "{output_folder}/module-brief-*.md"
+  - brainstorming_results: "{output_folder}/brainstorming-*.md"
+  - bmm_module: "{project-root}/bmad/bmm/"
+  - cis_module: "{project-root}/bmad/cis/"
+  - existing_agents: "{project-root}/bmad/*/agents/"
+  - existing_workflows: "{project-root}/bmad/*/workflows/"
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/create-module"
+template: false # This is an interactive scaffolding workflow
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Output configuration - creates entire module structure
+# Save to custom_module_location/{{module_code}}
+installer_output_folder: "{custom_module_location}/{{module_code}}"
+# Web bundle configuration

bmad/bmb/workflows/create-workflow/README.md

@@ -0,0 +1,216 @@
+# Build Workflow
+
+## Overview
+
+The Build Workflow is an interactive workflow builder that guides you through creating new BMAD workflows with proper structure, conventions, and validation. It ensures all workflows follow best practices for optimal human-AI collaboration and are fully compliant with the BMAD Core v6 workflow execution engine.
+
+## Key Features
+
+- **Optional Brainstorming Phase**: Creative exploration of workflow ideas before structured development
+- **Comprehensive Guidance**: Step-by-step process with detailed instructions and examples
+- **Template-Based**: Uses proven templates for all workflow components
+- **Convention Enforcement**: Ensures adherence to BMAD workflow creation guide
+- **README Generation**: Automatically creates comprehensive documentation
+- **Validation Built-In**: Includes checklist generation for quality assurance
+- **Type-Aware**: Adapts to document, action, interactive, autonomous, or meta-workflow types
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow create-workflow
+```
+
+### Through BMad Builder Agent
+
+```
+*create-workflow
+```
+
+### What You'll Be Asked
+
+1. **Optional**: Whether to brainstorm workflow ideas first (creative exploration phase)
+2. Workflow name and target module
+3. Workflow purpose and type (enhanced by brainstorming insights if used)
+4. Metadata (description, author, outputs)
+5. Step-by-step design (goals, variables, flow)
+6. Whether to include optional components
+
+## Workflow Structure
+
+### Files Included
+
+```
+create-workflow/
+├── workflow.yaml                  # Configuration and metadata
+├── instructions.md                # Step-by-step execution guide
+├── checklist.md                   # Validation criteria
+├── workflow-creation-guide.md     # Comprehensive reference guide
+├── README.md                      # This file
+└── workflow-template/             # Templates for new workflows
+    ├── workflow.yaml
+    ├── instructions.md
+    ├── template.md
+    ├── checklist.md
+    └── README.md
+```
+
+## Workflow Process
+
+### Phase 0: Optional Brainstorming (Step -1)
+
+- **Creative Exploration**: Option to brainstorm workflow ideas before structured development
+- **Design Concept Development**: Generate multiple approaches and explore different possibilities
+- **Requirement Clarification**: Use brainstorming output to inform workflow purpose, type, and structure
+- **Enhanced Creativity**: Leverage AI brainstorming tools for innovative workflow design
+
+The brainstorming phase invokes the CIS brainstorming workflow to:
+
+- Explore workflow ideas and approaches
+- Clarify requirements and use cases
+- Generate creative solutions for complex automation needs
+- Inform the structured workflow building process
+
+### Phase 1: Planning (Steps 0-3)
+
+- Load workflow creation guide and conventions
+- Define workflow purpose, name, and type (informed by brainstorming if used)
+- Gather metadata and configuration details
+- Design step structure and flow
+
+### Phase 2: Generation (Steps 4-8)
+
+- Create workflow.yaml with proper configuration
+- Generate instructions.md with XML-structured steps
+- Create template.md (for document workflows)
+- Generate validation checklist
+- Create supporting data files (optional)
+
+### Phase 3: Documentation and Validation (Steps 9-11)
+
+- Create comprehensive README.md (MANDATORY)
+- Test and validate workflow structure
+- Provide usage instructions and next steps
+
+## Output
+
+### Generated Workflow Folder
+
+Creates a complete workflow folder at:
+`{project-root}/bmad/{{target_module}}/workflows/{{workflow_name}}/`
+
+### Files Created
+
+**Always Created:**
+
+- `workflow.yaml` - Configuration with paths and variables
+- `README.md` - Comprehensive documentation (MANDATORY as of v6)
+- `instructions.md` - Execution steps (if not template-only workflow)
+
+**Conditionally Created:**
+
+- `template.md` - Document structure (for document workflows)
+- `checklist.md` - Validation criteria (optional but recommended)
+- Supporting data files (CSV, JSON, etc. as needed)
+
+### Output Structure
+
+For document workflows, the README documents:
+
+- Workflow purpose and use cases
+- Usage examples with actual commands
+- Input expectations
+- Output structure and location
+- Best practices
+
+## Requirements
+
+- Access to workflow creation guide
+- BMAD Core v6 project structure
+- Module to host the new workflow (bmm, bmb, cis, or custom)
+
+## Best Practices
+
+### Before Starting
+
+1. **Consider Brainstorming**: If you're unsure about the workflow approach, use the optional brainstorming phase
+2. Review the workflow creation guide to understand conventions
+3. Have a clear understanding of the workflow's purpose (or be ready to explore it creatively)
+4. Know which type of workflow you're creating (document, action, etc.) or be open to discovery
+5. Identify any data files or references needed
+
+### Creative Workflow Design
+
+The create-workflow now supports a **seamless transition from creative ideation to structured implementation**:
+
+- **"I need a workflow for something..."** → Start with brainstorming to explore possibilities
+- **Brainstorm** → Generate multiple approaches and clarify requirements
+- **Structured workflow** → Build the actual workflow using insights from brainstorming
+- **One seamless session** → Complete the entire process from idea to implementation
+
+### During Execution
+
+1. Follow kebab-case naming conventions
+2. Be specific with step goals and instructions
+3. Use descriptive variable names (snake_case)
+4. Set appropriate limits ("3-5 items maximum")
+5. Include examples where helpful
+
+### After Completion
+
+1. Test the newly created workflow
+2. Validate against the checklist
+3. Ensure README is comprehensive and accurate
+4. Test all file paths and variable references
+
+## Troubleshooting
+
+### Issue: Generated workflow won't execute
+
+- **Solution**: Verify all file paths in workflow.yaml use proper variable substitution
+- **Check**: Ensure installed_path and project-root are correctly set
+
+### Issue: Variables not replacing in template
+
+- **Solution**: Ensure variable names match exactly between instructions `<template-output>` tags and template `{{variables}}`
+- **Check**: Use snake_case consistently
+
+### Issue: README has placeholder text
+
+- **Solution**: This workflow now enforces README generation - ensure Step 10 completed fully
+- **Check**: No {WORKFLOW_TITLE} or similar placeholders should remain
+
+## Customization
+
+To modify this workflow:
+
+1. Edit `instructions.md` to adjust the creation process
+2. Update templates in `workflow-template/` to change generated files
+3. Modify `workflow-creation-guide.md` to update conventions
+4. Edit `checklist.md` to change validation criteria
+
+## Version History
+
+- **v6.0.0** - README.md now MANDATORY for all workflows
+  - Added comprehensive README template
+  - Enhanced validation for documentation
+  - Improved Step 10 with detailed README requirements
+
+- **v5.0.0** - Initial BMAD Core v6 compatible version
+  - Template-based workflow generation
+  - Convention enforcement
+  - Validation checklist support
+
+## Support
+
+For issues or questions:
+
+- Review `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Check existing workflows in `/bmad/bmm/workflows/` for examples
+- Validate against `/bmad/bmb/workflows/create-workflow/checklist.md`
+- Consult BMAD Method v6 documentation
+
+---
+
+_Part of the BMad Method v6 - BMB (BMad Builder) Module_

bmad/bmb/workflows/create-workflow/brainstorm-context.md

@@ -0,0 +1,197 @@
+# Workflow Brainstorming Context
+
+_Context provided to brainstorming workflow when creating a new BMAD workflow_
+
+## Session Focus
+
+You are brainstorming ideas for a **BMAD workflow** - a guided, multi-step process that helps users accomplish complex tasks with structure, consistency, and quality.
+
+## What is a BMAD Workflow?
+
+A workflow is a structured process that provides:
+
+- **Clear Steps**: Sequential operations with defined goals
+- **User Guidance**: Prompts, questions, and decisions at each phase
+- **Quality Output**: Documents, artifacts, or completed actions
+- **Repeatability**: Same process yields consistent results
+- **Type**: Document (creates docs), Action (performs tasks), Interactive (guides sessions), Autonomous (runs automated), Meta (orchestrates other workflows)
+
+## Brainstorming Goals
+
+Explore and define:
+
+### 1. Problem and Purpose
+
+- **What task needs structure?** (specific process users struggle with)
+- **Why is this hard manually?** (complexity, inconsistency, missing steps)
+- **What would ideal process look like?** (steps, checkpoints, outputs)
+- **Who needs this?** (target users and their pain points)
+
+### 2. Process Flow
+
+- **How many phases?** (typically 3-10 major steps)
+- **What's the sequence?** (logical flow from start to finish)
+- **What decisions are needed?** (user choices that affect path)
+- **What's optional vs required?** (flexibility points)
+- **What checkpoints matter?** (validation, review, approval points)
+
+### 3. Inputs and Outputs
+
+- **What inputs are needed?** (documents, data, user answers)
+- **What outputs are generated?** (documents, code, configurations)
+- **What format?** (markdown, XML, YAML, actions)
+- **What quality criteria?** (how to validate success)
+
+### 4. Workflow Type and Style
+
+- **Document Workflow?** Creates structured documents (PRDs, specs, reports)
+- **Action Workflow?** Performs operations (refactoring, deployment, analysis)
+- **Interactive Workflow?** Guides creative process (brainstorming, planning)
+- **Autonomous Workflow?** Runs without user input (batch processing, generation)
+- **Meta Workflow?** Orchestrates other workflows (project setup, module creation)
+
+## Creative Constraints
+
+A great BMAD workflow should be:
+
+- **Focused**: Solves one problem well (not everything)
+- **Structured**: Clear phases with defined goals
+- **Flexible**: Optional steps, branching paths where appropriate
+- **Validated**: Checklist to verify completeness and quality
+- **Documented**: README explains when and how to use it
+
+## Workflow Architecture Questions
+
+### Core Structure
+
+1. **Workflow name** (kebab-case, e.g., "product-brief")
+2. **Purpose** (one sentence)
+3. **Type** (document/action/interactive/autonomous/meta)
+4. **Major phases** (3-10 high-level steps)
+5. **Output** (what gets created)
+
+### Process Details
+
+1. **Required inputs** (what user must provide)
+2. **Optional inputs** (what enhances results)
+3. **Decision points** (where user chooses path)
+4. **Checkpoints** (where to pause for approval)
+5. **Variables** (data passed between steps)
+
+### Quality and Validation
+
+1. **Success criteria** (what defines "done")
+2. **Validation checklist** (measurable quality checks)
+3. **Common issues** (troubleshooting guidance)
+4. **Best practices** (tips for optimal results)
+
+## Workflow Pattern Examples
+
+### Document Generation Workflows
+
+- **Product Brief**: Idea → Vision → Features → Market → Output
+- **PRD**: Requirements → User Stories → Acceptance Criteria → Document
+- **Architecture**: Requirements → Decisions → Design → Diagrams → ADRs
+- **Technical Spec**: Epic → Implementation → Testing → Deployment → Doc
+
+### Action Workflows
+
+- **Code Refactoring**: Analyze → Plan → Refactor → Test → Commit
+- **Deployment**: Build → Test → Stage → Validate → Deploy → Monitor
+- **Migration**: Assess → Plan → Convert → Validate → Deploy
+- **Analysis**: Collect → Process → Analyze → Report → Recommend
+
+### Interactive Workflows
+
+- **Brainstorming**: Setup → Generate → Expand → Evaluate → Prioritize
+- **Planning**: Context → Goals → Options → Decisions → Plan
+- **Review**: Load → Analyze → Critique → Suggest → Document
+
+### Meta Workflows
+
+- **Project Setup**: Plan → Architecture → Stories → Setup → Initialize
+- **Module Creation**: Brainstorm → Brief → Agents → Workflows → Install
+- **Sprint Planning**: Backlog → Capacity → Stories → Commit → Kickoff
+
+## Workflow Design Patterns
+
+### Linear Flow
+
+Simple sequence: Step 1 → Step 2 → Step 3 → Done
+
+**Good for:**
+
+- Document generation
+- Structured analysis
+- Sequential builds
+
+### Branching Flow
+
+Conditional paths: Step 1 → [Decision] → Path A or Path B → Merge → Done
+
+**Good for:**
+
+- Different project types
+- Optional deep dives
+- Scale-adaptive processes
+
+### Iterative Flow
+
+Refinement loops: Step 1 → Step 2 → [Review] → (Repeat if needed) → Done
+
+**Good for:**
+
+- Creative processes
+- Quality refinement
+- Approval cycles
+
+### Router Flow
+
+Type selection: [Select Type] → Load appropriate instructions → Execute → Done
+
+**Good for:**
+
+- Multi-mode workflows
+- Reusable frameworks
+- Flexible tools
+
+## Suggested Brainstorming Techniques
+
+Particularly effective for workflow ideation:
+
+1. **Process Mapping**: Draw current painful process, identify improvements
+2. **Step Decomposition**: Break complex task into atomic steps
+3. **Checkpoint Thinking**: Where do users need pause/review/decision?
+4. **Pain Point Analysis**: What makes current process frustrating?
+5. **Success Visualization**: What does perfect execution look like?
+
+## Key Questions to Answer
+
+1. What manual process needs structure and guidance?
+2. What makes this process hard or inconsistent today?
+3. What are the 3-10 major phases/steps?
+4. What document or output gets created?
+5. What inputs are required from the user?
+6. What decisions or choices affect the flow?
+7. What quality criteria define success?
+8. Document, Action, Interactive, Autonomous, or Meta workflow?
+9. What makes this workflow valuable vs doing it manually?
+10. What would make this workflow delightful to use?
+
+## Output Goals
+
+Generate:
+
+- **Workflow name**: Clear, describes the process
+- **Purpose statement**: One sentence explaining value
+- **Workflow type**: Classification with rationale
+- **Phase outline**: 3-10 major steps with goals
+- **Input/output description**: What goes in, what comes out
+- **Key decisions**: Where user makes choices
+- **Success criteria**: How to know it worked
+- **Unique value**: Why this workflow beats manual process
+- **Use cases**: 3-5 scenarios where this workflow shines
+
+---
+
+_This focused context helps create valuable, structured BMAD workflows_

bmad/bmb/workflows/create-workflow/checklist.md

@@ -0,0 +1,94 @@
+# Build Workflow - Validation Checklist
+
+## Workflow Configuration (workflow.yaml)
+
+- [ ] Name follows kebab-case convention
+- [ ] Description clearly states workflow purpose
+- [ ] All paths use proper variable substitution
+- [ ] installed_path points to correct module location
+- [ ] template/instructions paths are correct for workflow type
+- [ ] Output file pattern is appropriate
+- [ ] YAML syntax is valid (no parsing errors)
+
+## Instructions Structure (instructions.md)
+
+- [ ] Critical headers reference workflow engine
+- [ ] All steps have sequential numbering
+- [ ] Each step has a clear goal attribute
+- [ ] Optional steps marked with optional="true"
+- [ ] Repeating steps have appropriate repeat attributes
+- [ ] All template-output tags have unique variable names
+- [ ] Flow control (if any) has valid step references
+
+## Template Structure (if document workflow)
+
+- [ ] All sections have appropriate placeholders
+- [ ] Variable names match template-output tags exactly
+- [ ] Markdown formatting is valid
+- [ ] Date and metadata fields included
+- [ ] No unreferenced variables remain
+
+## Content Quality
+
+- [ ] Instructions are specific and actionable
+- [ ] Examples provided where helpful
+- [ ] Limits set for lists and content length
+- [ ] User prompts are clear
+- [ ] Step goals accurately describe outcomes
+
+## Validation Checklist (if present)
+
+- [ ] Criteria are measurable and specific
+- [ ] Checks grouped logically by category
+- [ ] Final validation summary included
+- [ ] All critical requirements covered
+
+## File System
+
+- [ ] Workflow folder created in correct module
+- [ ] All required files present based on workflow type
+- [ ] File permissions allow execution
+- [ ] No placeholder text remains (like {TITLE})
+
+## Testing Readiness
+
+- [ ] Workflow can be invoked without errors
+- [ ] All required inputs are documented
+- [ ] Output location is writable
+- [ ] Dependencies (if any) are available
+
+## Web Bundle Configuration (if applicable)
+
+- [ ] web_bundle section present if needed
+- [ ] Name, description, author copied from main config
+- [ ] All file paths converted to bmad/-relative format
+- [ ] NO {config_source} variables in web bundle
+- [ ] NO {project-root} prefixes in paths
+- [ ] Instructions path listed correctly
+- [ ] Validation/checklist path listed correctly
+- [ ] Template path listed (if document workflow)
+- [ ] All data files referenced in instructions are listed
+- [ ] All sub-workflows are included
+- [ ] web_bundle_files array is complete:
+  - [ ] Instructions.md included
+  - [ ] Checklist.md included
+  - [ ] Template.md included (if applicable)
+  - [ ] All CSV/JSON data files included
+  - [ ] All referenced templates included
+  - [ ] All sub-workflow files included
+- [ ] No external dependencies outside bundle
+
+## Documentation
+
+- [ ] README created (if requested)
+- [ ] Usage instructions clear
+- [ ] Example command provided
+- [ ] Special requirements noted
+- [ ] Web bundle deployment noted (if applicable)
+
+## Final Validation
+
+- [ ] Configuration: No issues
+- [ ] Instructions: Complete and clear
+- [ ] Template: Variables properly mapped
+- [ ] Testing: Ready for test run