proagents 1.6.16 → 1.6.18

package/.proagents/reporting/exports.md

@@ -1,524 +0,0 @@
-# Report Exports
-
-Export reports in various formats for sharing and archival.
-
----
-
-## Export Overview
-
-```
-┌─────────────────────────────────────────────────────────────┐
-│                    Report Export System                      │
-├─────────────────────────────────────────────────────────────┤
-│                                                             │
-│  Report Data                                                │
-│       │                                                     │
-│       ▼                                                     │
-│  ┌─────────────┐                                           │
-│  │  Formatter  │                                           │
-│  └─────────────┘                                           │
-│       │                                                     │
-│       ├──▶ PDF        (Management reports)                 │
-│       ├──▶ HTML       (Interactive dashboards)             │
-│       ├──▶ Markdown   (Documentation)                      │
-│       ├──▶ CSV        (Data analysis)                      │
-│       ├──▶ JSON       (API integration)                    │
-│       └──▶ Excel      (Spreadsheet analysis)               │
-│                                                             │
-└─────────────────────────────────────────────────────────────┘
-```
-
----
-
-## Export Configuration
-
-### Format Settings
-
-```yaml
-reporting:
-  exports:
-    # Default format
-    default_format: "pdf"
-
-    # Available formats
-    formats:
-      pdf:
-        enabled: true
-        template: "professional"
-        include_charts: true
-        page_size: "letter"  # letter, A4
-
-      html:
-        enabled: true
-        interactive: true
-        include_scripts: true
-
-      markdown:
-        enabled: true
-        include_diagrams: true
-        github_flavored: true
-
-      csv:
-        enabled: true
-        delimiter: ","
-        include_headers: true
-
-      json:
-        enabled: true
-        pretty_print: true
-
-      excel:
-        enabled: true
-        include_charts: true
-        multiple_sheets: true
-```
-
-### Output Settings
-
-```yaml
-reporting:
-  exports:
-    output:
-      # Directory
-      directory: ".proagents/reports/exports/"
-
-      # Naming
-      filename_format: "{{report_type}}-{{date}}.{{format}}"
-
-      # Compression
-      compress: true
-      compression_format: "zip"  # zip, tar.gz
-
-      # Cleanup
-      retention_days: 90
-```
-
----
-
-## Export Commands
-
-### CLI Export
-
-```bash
-# Export velocity report as PDF
-proagents report velocity --export pdf
-
-# Export to specific file
-proagents report quality --export pdf --output ./reports/q1-quality.pdf
-
-# Export multiple formats
-proagents report velocity --export pdf,csv,json
-
-# Export all reports
-proagents report export-all --format pdf
-
-# Export with date range
-proagents report velocity --from 2024-01-01 --to 2024-01-31 --export pdf
-```
-
-### Batch Export
-
-```bash
-# Export all reports for a period
-proagents report batch-export \
-  --from 2024-01-01 \
-  --to 2024-01-31 \
-  --formats pdf,csv \
-  --output ./monthly-reports/
-
-# Schedule recurring export
-proagents report schedule \
-  --report velocity \
-  --format pdf \
-  --frequency weekly \
-  --email team@company.com
-```
-
----
-
-## PDF Exports
-
-### PDF Configuration
-
-```yaml
-reporting:
-  exports:
-    pdf:
-      # Template
-      template: "professional"  # professional, minimal, detailed
-
-      # Branding
-      branding:
-        logo: "./assets/company-logo.png"
-        primary_color: "#1a73e8"
-        font_family: "Inter"
-
-      # Layout
-      layout:
-        page_size: "letter"
-        orientation: "portrait"
-        margins:
-          top: "1in"
-          bottom: "1in"
-          left: "0.75in"
-          right: "0.75in"
-
-      # Content
-      content:
-        include_toc: true
-        include_charts: true
-        include_summary: true
-        page_numbers: true
-        header: "{{report_title}}"
-        footer: "Generated by ProAgents | {{date}}"
-```
-
-### PDF Example
-
-```
-┌─────────────────────────────────────────────────────────────┐
-│                                              [Company Logo] │
-│                                                             │
-│  ═══════════════════════════════════════════════════════    │
-│           Development Velocity Report                       │
-│           January 2024                                      │
-│  ═══════════════════════════════════════════════════════    │
-│                                                             │
-│  Table of Contents                                          │
-│  ─────────────────                                          │
-│  1. Executive Summary ............................ 2        │
-│  2. Velocity Metrics ............................. 3        │
-│  3. Feature Completion ........................... 5        │
-│  4. Team Performance ............................. 7        │
-│  5. Recommendations .............................. 9        │
-│                                                             │
-│  ──────────────────────────────────────────────────────     │
-│  Generated by ProAgents | January 31, 2024    Page 1 of 10 │
-└─────────────────────────────────────────────────────────────┘
-```
-
----
-
-## HTML Exports
-
-### Interactive HTML
-
-```yaml
-reporting:
-  exports:
-    html:
-      # Interactive features
-      interactive:
-        sortable_tables: true
-        filterable: true
-        expandable_sections: true
-        tooltips: true
-
-      # Charts
-      charts:
-        library: "chart.js"  # chart.js, d3, echarts
-        interactive: true
-        exportable: true
-
-      # Styling
-      styling:
-        theme: "light"  # light, dark, auto
-        responsive: true
-        print_friendly: true
-```
-
-### Self-Contained HTML
-
-```yaml
-reporting:
-  exports:
-    html:
-      # Bundle all resources
-      self_contained: true
-
-      # Include
-      include:
-        - css
-        - javascript
-        - fonts
-        - images
-
-      # Minify
-      minify: true
-```
-
----
-
-## CSV/Excel Exports
-
-### CSV Configuration
-
-```yaml
-reporting:
-  exports:
-    csv:
-      # Format
-      delimiter: ","
-      quote_char: "\""
-      escape_char: "\\"
-      line_ending: "\n"  # \n, \r\n
-
-      # Headers
-      include_headers: true
-      header_row: true
-
-      # Data handling
-      null_value: ""
-      date_format: "YYYY-MM-DD"
-      number_format: "0.00"
-```
-
-### Excel Configuration
-
-```yaml
-reporting:
-  exports:
-    excel:
-      # Multiple sheets
-      multiple_sheets: true
-
-      sheets:
-        - name: "Summary"
-          data: "summary"
-        - name: "Velocity"
-          data: "velocity_details"
-        - name: "Quality"
-          data: "quality_metrics"
-        - name: "Raw Data"
-          data: "raw_metrics"
-
-      # Formatting
-      formatting:
-        header_style:
-          bold: true
-          background: "#1a73e8"
-          color: "#ffffff"
-
-        # Conditional formatting
-        conditional:
-          - column: "coverage"
-            rule: "< 80"
-            style:
-              background: "#ffcccc"
-          - column: "coverage"
-            rule: ">= 80"
-            style:
-              background: "#ccffcc"
-
-      # Charts in Excel
-      include_charts: true
-```
-
----
-
-## JSON Exports
-
-### JSON Structure
-
-```yaml
-reporting:
-  exports:
-    json:
-      # Format
-      pretty_print: true
-      indent: 2
-
-      # Structure
-      structure: "nested"  # nested, flat
-
-      # Include
-      include:
-        metadata: true
-        timestamps: true
-        version: true
-
-      # Schema
-      include_schema: true
-```
-
-### JSON Example
-
-```json
-{
-  "metadata": {
-    "report_type": "velocity",
-    "generated_at": "2024-01-31T10:00:00Z",
-    "period": {
-      "from": "2024-01-01",
-      "to": "2024-01-31"
-    },
-    "version": "1.0"
-  },
-  "summary": {
-    "features_completed": 15,
-    "bugs_fixed": 42,
-    "average_completion_time": "2.3 days"
-  },
-  "details": {
-    "features": [...],
-    "bugs": [...],
-    "by_developer": [...]
-  }
-}
-```
-
----
-
-## Scheduled Exports
-
-### Schedule Configuration
-
-```yaml
-reporting:
-  exports:
-    schedules:
-      # Daily summary
-      - name: "daily_summary"
-        report: "velocity"
-        format: "html"
-        frequency: "daily"
-        time: "08:00"
-        timezone: "America/New_York"
-        recipients:
-          - "team@company.com"
-
-      # Weekly report
-      - name: "weekly_report"
-        report: "all"
-        format: "pdf"
-        frequency: "weekly"
-        day: "monday"
-        time: "09:00"
-        recipients:
-          - "management@company.com"
-
-      # Monthly summary
-      - name: "monthly_summary"
-        report: "all"
-        format: "pdf,excel"
-        frequency: "monthly"
-        day: 1
-        time: "09:00"
-        recipients:
-          - "stakeholders@company.com"
-        archive: true
-```
-
-### Delivery Methods
-
-```yaml
-reporting:
-  exports:
-    delivery:
-      # Email
-      email:
-        enabled: true
-        from: "reports@company.com"
-        smtp:
-          host: "smtp.company.com"
-          port: 587
-          auth_env:
-            user: "SMTP_USER"
-            password: "SMTP_PASSWORD"
-
-      # Slack
-      slack:
-        enabled: true
-        channel: "#reports"
-        include_preview: true
-
-      # Cloud storage
-      cloud:
-        enabled: true
-        provider: "s3"  # s3, gcs, azure
-        bucket: "company-reports"
-        path: ".proagents/{{year}}/{{month}}/"
-
-      # Webhook
-      webhook:
-        enabled: true
-        url: "https://api.company.com/reports"
-        method: "POST"
-```
-
----
-
-## Export Templates
-
-### Custom Templates
-
-```yaml
-reporting:
-  exports:
-    templates:
-      # Define custom template
-      executive_summary:
-        format: "pdf"
-        sections:
-          - type: "header"
-            title: "Executive Summary"
-          - type: "metrics"
-            metrics: ["features_completed", "velocity", "quality_score"]
-          - type: "chart"
-            chart_type: "trend"
-            data: "velocity_trend"
-          - type: "table"
-            title: "Top Achievements"
-            data: "achievements"
-          - type: "recommendations"
-            max_items: 5
-
-      # Technical report
-      technical_report:
-        format: "pdf"
-        sections:
-          - type: "header"
-            title: "Technical Report"
-          - type: "coverage"
-          - type: "quality_breakdown"
-          - type: "security_summary"
-          - type: "performance_metrics"
-          - type: "code_metrics"
-```
-
----
-
-## Export Status
-
-```
-┌─────────────────────────────────────────────────────────────┐
-│ Export Status                                               │
-├─────────────────────────────────────────────────────────────┤
-│                                                             │
-│ Recent Exports:                                             │
-│ ├── velocity-2024-01-31.pdf      ✅ Complete (2 min ago)   │
-│ ├── quality-2024-01-31.csv       ✅ Complete (5 min ago)   │
-│ └── monthly-summary.pdf          🔄 Processing (30%)       │
-│                                                             │
-│ Scheduled Exports:                                          │
-│ ├── daily_summary     Next: Tomorrow 08:00 AM              │
-│ ├── weekly_report     Next: Monday 09:00 AM                │
-│ └── monthly_summary   Next: Feb 1, 09:00 AM                │
-│                                                             │
-│ Storage: 45 MB used (90 day retention)                      │
-│                                                             │
-│ [View All] [Download Recent] [Clear Old]                   │
-│                                                             │
-└─────────────────────────────────────────────────────────────┘
-```
-
----
-
-## Best Practices
-
-1. **Choose Right Format**: PDF for sharing, CSV for analysis
-2. **Schedule Regular Exports**: Automate recurring reports
-3. **Archive Important Reports**: Keep historical data
-4. **Secure Sensitive Data**: Encrypt exports with sensitive info
-5. **Test Templates**: Verify formatting before distribution
-6. **Monitor Storage**: Clean up old exports regularly