warmbox/docs/README.md

2.8 KiB
Raw Blame History

Warmbox Documentation

Planning artifacts for evolving Warmbox from a barebone MVP into a production-grade cold email warmup platform and eventual SaaS.

Decisions (confirmed)

Decision Choice
Deployment Hybrid — self-hosted + web UI first; architecture ready for multi-tenant SaaS later
Satellite pool Own satellites first; optional shared peer network in a later phase
Warmup duration 3045 days recommended default
Reply rate default 30% (max recommended 45%)
Daily volume Min 1, default max 40, hard cap 50

Document index

# Document Purpose
00 Product Brief Vision, personas, success metrics
01 Current State & Gaps MVP inventory vs target
02 Glossary Domain language
03 Domain Model Future entities & relationships
04 Warmup Recipes Grow, Flat, Randomized, Custom specs
05 Primary & Satellite Topology Multi-primary warmup design
06 Scheduling & Timing Duration, windows, jitter
07 Reply Rate Engine Probabilistic replies
08 Spam Rescue Rescue, placement tracking
09 AI Content Policy Safe B2B content rules
10 Statistics & Reporting Metrics & dashboards
11 ESP Compliance Playbook Anti-detection, DNS, policies
12 Architecture System design (hybrid → SaaS)
13 API Evolution REST roadmap
14 Frontend UX Spec Web UI screens & flows
15 Security & Compliance Credentials, privacy, legal
16 Roadmap Phased delivery plan
17 Agile Epics & Backlog Epics, stories, integrations
18 Open Questions Unresolved decisions
19 Risk Register Risks & mitigations

How to use these docs

  1. Product — Start with 00, 16, 17 for prioritization.
  2. Engineering — Use 0313 as implementation specs per integration.
  3. Each sprint — Pick one epic from 17, cross-reference the relevant spec doc, update 18 when decisions are made.
Epic (17) → Technical spec (0313) → Implementation PR → Stats/metrics validation (10)

Sprints should ship vertical slices (e.g. "Primary inbox + Grow recipe + daily stats") rather than horizontal layers only.