README.md
1 --- 2 title: 'Documentation Hub' 3 last_verified: '2026-02-15' 4 tags: ['navigation', 'index', 'documentation'] 5 status: 'current' 6 --- 7 8 # 333 Method Documentation 9 10 Welcome to the 333 Method automation pipeline documentation. This documentation is organized into 9 categories for easy navigation. 11 12 ## 📚 Documentation Structure 13 14 ### [01 - Getting Started](01-getting-started/) 15 16 Quick start guides, environment setup, and essential commands. 17 18 - [Setup Guide](01-getting-started/setup.md) - Environment configuration and quality tools 19 - [Commands Reference](01-getting-started/commands-reference.md) - Complete npm scripts and CLI commands 20 21 ### [02 - Architecture](02-architecture/) 22 23 System architecture, design patterns, and technical implementation. 24 25 - [Architecture Overview](02-architecture/architecture.md) - Core system design and patterns 26 - [Functional Specification](02-architecture/functional-spec.md) - Original design document 27 - [Bot Detection](02-architecture/bot-detection.md) - Stealth browser and anti-detection 28 29 ### [03 - Pipeline](03-pipeline/) 30 31 9-stage pipeline documentation: Keywords → SERPs → Assets → Scoring → Rescoring → Enrich → Proposals → Outreach → Replies. 32 33 - [Scoring System](03-pipeline/scoring-system.md) - AI vision scoring and grading 34 - [Capacity Analysis](03-pipeline/capacity-analysis.md) - Pipeline throughput and performance 35 - [Outreach Strategy](03-pipeline/outreach-strategy.md) - Multi-channel outreach approach 36 - [Deduplication](03-pipeline/deduplication.md) - Contact deduplication strategy 37 - [HTML-Only Analysis](03-pipeline/html-only-analysis.md) - HTML-based scoring approach 38 39 ### [04 - Proposals](04-proposals/) 40 41 Proposal generation, templates, and approval workflow. 42 43 - [Template System](04-proposals/template-system.md) - Spintax templates and generation 44 - [Workflow](04-proposals/workflow.md) - QA approval workflow with Google Sheets 45 - [Compliance Review](04-proposals/compliance-review.md) - Legal and compliance checks 46 - [Country Templates](04-proposals/country-templates.md) - Country-specific templates 47 48 ### [05 - Outreach](05-outreach/) 49 50 Multi-channel outreach: email, SMS, forms, X, LinkedIn. 51 52 - [Email Best Practices](05-outreach/email-best-practices.md) - CAN-SPAM compliance 53 - [SMS Best Practices](05-outreach/sms-best-practices.md) - TCPA compliance 54 - [Browser Profiles](05-outreach/browser-profiles.md) - Persistent profiles for social media 55 - [Resend Testing](05-outreach/testing/resend-integration.md) - Email integration tests 56 - [Twilio Testing](05-outreach/testing/twilio-integration.md) - SMS integration tests 57 58 ### [06 - Automation](06-automation/) 59 60 Automated scheduling, agent systems, and deployment. 61 62 - [Cron System](06-automation/cron-system.md) - **⭐ Merged cron documentation** (replaces 4 docs) 63 - [Agent System](06-automation/agent-system.md) - Multi-agent development system 64 - [NixOS Cron](06-automation/nixos-cron.md) - NixOS cron configuration 65 - [NixOS Service](06-automation/nixos-service.md) - Systemd service setup 66 67 ### [07 - Integrations](07-integrations/) 68 69 External services, APIs, and monitoring dashboards. 70 71 - [LLM Integration](07-integrations/llm-integration.md) - LLM API patterns 72 - [Circuit Breaker](07-integrations/circuit-breaker.md) - API resilience patterns 73 - [Dashboard](07-integrations/dashboard.md) - Streamlit analytics dashboard 74 - [Dashboard Performance](07-integrations/dashboard-performance.md) - Performance optimization 75 - [Inbound Processing](07-integrations/inbound-processing.md) - Enhanced reply handling 76 77 ### [08 - Operations](08-operations/) 78 79 System operations, maintenance, security, and monitoring. 80 81 - [Maintenance](08-operations/maintenance.md) - System maintenance procedures 82 - [Maintenance Automation](08-operations/maintenance-automation.md) - Automated tasks 83 - [Logging](08-operations/logging.md) - Log management and rotation 84 - [Security](08-operations/security.md) - Security audits and best practices 85 - [Workflows](08-operations/workflows.md) - Common operational workflows 86 87 ### [09 - Business](09-business/) 88 89 Business strategy, pricing, market expansion, and financials. 90 91 - [Pricing Strategy](09-business/pricing-strategy.md) - Pricing optimization 92 - [Cultural Pricing](09-business/cultural-pricing.md) - Localization and cultural factors 93 - [Profit Estimates](09-business/profit-estimates.md) - Financial projections 94 - [Market Expansion](09-business/market-expansion.md) - Multi-country strategy 95 - [TAM Expansion](09-business/tam-expansion.md) - Total addressable market 96 97 ### [90 - Archive](90-archive/) 98 99 Deprecated and merged documentation, kept for historical reference. 100 101 - [Archive Index](90-archive/README.md) - See what was merged and why 102 103 ## 🔍 Quick Find 104 105 ### By Topic 106 107 **Setup & Configuration** 108 109 - [Environment Setup](01-getting-started/setup.md) 110 - [Commands Reference](01-getting-started/commands-reference.md) 111 - [Architecture Overview](02-architecture/architecture.md) 112 113 **Pipeline Operations** 114 115 - [Scoring System](03-pipeline/scoring-system.md) 116 - [Outreach Strategy](03-pipeline/outreach-strategy.md) 117 - [Proposal Templates](04-proposals/template-system.md) 118 119 **Automation & Scheduling** 120 121 - [Cron System](06-automation/cron-system.md) - Complete cron documentation 122 - [Agent System](06-automation/agent-system.md) 123 - [Maintenance Tasks](08-operations/maintenance.md) 124 125 **Compliance & Best Practices** 126 127 - [Email Compliance](05-outreach/email-best-practices.md) 128 - [SMS Compliance](05-outreach/sms-best-practices.md) 129 - [Security Best Practices](08-operations/security.md) 130 131 **Business & Strategy** 132 133 - [Pricing Strategy](09-business/pricing-strategy.md) 134 - [Market Expansion](09-business/market-expansion.md) 135 - [Profit Estimates](09-business/profit-estimates.md) 136 137 ### By Role 138 139 **Developer** 140 141 - [Getting Started](01-getting-started/) - Setup and commands 142 - [Architecture](02-architecture/) - System design 143 - [Operations](08-operations/) - Maintenance and logging 144 145 **Product Manager** 146 147 - [Pipeline](03-pipeline/) - Pipeline stages and strategy 148 - [Proposals](04-proposals/) - Template system 149 - [Business](09-business/) - Pricing and market strategy 150 151 **DevOps** 152 153 - [Automation](06-automation/) - Cron and agents 154 - [Integrations](07-integrations/) - External services 155 - [Operations](08-operations/) - System maintenance 156 157 **Compliance Officer** 158 159 - [Email Best Practices](05-outreach/email-best-practices.md) 160 - [SMS Best Practices](05-outreach/sms-best-practices.md) 161 - [Security](08-operations/security.md) 162 163 ## 📊 Documentation Metadata 164 165 All documentation files include YAML frontmatter with: 166 167 - `title` - Human-readable title 168 - `category` - Category folder name 169 - `last_verified` - Date documentation was last verified 170 - `related_files` - Associated code files (for staleness detection) 171 - `tags` - Searchable keywords 172 - `status` - current | deprecated | archived 173 - `replaces` - Original docs merged into this file (if applicable) 174 175 ## 🔄 Merged Documentation 176 177 To reduce duplication and improve maintainability, several related documents were merged: 178 179 | New Document | Replaced Documents | Date | 180 | ------------------------------------------------------------ | ------------------------------------------------------------------------ | ---------- | 181 | [06-automation/cron-system.md](06-automation/cron-system.md) | CRON-JOBS.md, CRON-SETUP.md, CRON-QUICK-START.md, CRON-BATCH-STRATEGY.md | 2026-02-15 | 182 183 See [Archive README](90-archive/README.md) for full list of archived documents and rationale. 184 185 ## 🛠️ Maintenance 186 187 ### Keeping Docs Current 188 189 1. **Verify Related Code**: When code changes, update corresponding docs 190 2. **Update last_verified**: Set date when you verify accuracy 191 3. **Add Related Files**: Link to relevant code files 192 4. **Tag Appropriately**: Add searchable tags for easy discovery 193 194 ### Automated Staleness Detection 195 196 ```bash 197 # Check which docs reference changed code (planned) 198 npm run docs:check-freshness 199 ``` 200 201 ### Contributing 202 203 When creating new documentation: 204 205 1. Place in appropriate category folder 206 2. Add YAML frontmatter (use existing docs as template) 207 3. Update category README.md 208 4. Link from related documents 209 5. Run `npm run format` before committing 210 211 ## 📁 Other Documentation 212 213 - [TODO.md](TODO.md) - Active task tracking 214 - [Plans Directory](plans/) - Architecture and planning documents 215 216 ## 🔗 External Resources 217 218 - [Project Repository](https://github.com/user/333Method) 219 - [Main README](/home/jason/code/333Method/README.md) - Project overview 220 - [CLAUDE.md](/home/jason/code/333Method/CLAUDE.md) - AI assistant instructions 221 222 ## 📧 Questions? 223 224 For questions about specific documentation: 225 226 1. Check the category README for related docs 227 2. Review the [Archive](90-archive/) for historical context 228 3. Check related code files listed in frontmatter 229 4. Review git history for context: `git log -- path/to/doc.md` 230 231 --- 232 233 **Last Updated:** 2026-02-15 234 **Documentation Version:** 2.0 (Restructured)