jonnyn/warmbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
warmbox/docs
History
Jonny Nguyen ed3ec86025 Add Woodpecker CI/CD pipeline configuration and new chart components 
Introduce a Woodpecker CI/CD pipeline in `.woodpecker.yml` for automated deployment on pushes to the main branch. Add new components for visualizing campaign performance, including `DailyPerformanceChart`, `InboxPlacementChart`, and `InboxVsSpamChart`, to enhance the Campaign Detail page. Update `WarmupPlanChart` to include additional metrics and improve tooltip information. Enhance utility functions for chart data formatting and daily statistics mapping.
2026-06-26 14:23:18 -07:00
..
sprints Refactor project structure to support monorepo with workspaces; add API and web applications with respective configurations, dependencies, and scripts. Introduce environment variable validation and initial API setup for email warmup functionality. 2026-06-25 22:01:25 -07:00
00-product-brief.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
01-current-state-and-gaps.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
02-glossary.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
03-domain-model.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
04-warmup-recipes.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
05-primary-satellite-topology.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
06-scheduling-and-timing.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
07-reply-rate-engine.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
08-spam-rescue-and-placement.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
09-ai-content-policy.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
10-statistics-and-reporting.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
11-esp-compliance-playbook.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
12-architecture.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
13-api-evolution.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
14-frontend-ux-spec.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
15-security-and-compliance.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
16-roadmap.md Refactor project structure to support monorepo with workspaces; add API and web applications with respective configurations, dependencies, and scripts. Introduce environment variable validation and initial API setup for email warmup functionality. 2026-06-25 22:01:25 -07:00
17-agile-epics-backlog.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
18-open-questions.md Refactor project structure to support monorepo with workspaces; add API and web applications with respective configurations, dependencies, and scripts. Introduce environment variable validation and initial API setup for email warmup functionality. 2026-06-25 22:01:25 -07:00
19-risk-register.md Add initial documentation for Warmbox, including product brief, current state analysis, glossary, domain model, warmup recipes, primary-satellite topology, scheduling, reply rate engine, spam rescue, AI content policy, statistics, ESP compliance, system architecture, API evolution, and frontend UX specification. 2026-06-24 22:40:25 -07:00
deploy-ci-cd.md Add Woodpecker CI/CD pipeline configuration and new chart components 2026-06-26 14:23:18 -07:00
deploy-ubuntu-docker.md Add Woodpecker CI/CD pipeline configuration and new chart components 2026-06-26 14:23:18 -07:00
fillcare-qa-playbook.md Refactor project structure to support monorepo with workspaces; add API and web applications with respective configurations, dependencies, and scripts. Introduce environment variable validation and initial API setup for email warmup functionality. 2026-06-25 22:01:25 -07:00
README.md Refactor project structure to support monorepo with workspaces; add API and web applications with respective configurations, dependencies, and scripts. Introduce environment variable validation and initial API setup for email warmup functionality. 2026-06-25 22:01:25 -07:00
self-host-hardening.md Update .env.example with new PUBLIC_BASE_URL, remove unused docker-compose.npm.yml and Caddyfile, and adjust docker-compose.yml to simplify network configuration. Revise deployment documentation to reflect changes in setup and clarify Nginx Proxy Manager integration. 2026-06-26 13:00:32 -07:00

README.md

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 30–45 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
— Sprint 1.1 Campaigns, Grow recipe, AI validator
— Sprint 1.2–1.3 All recipes, campaign dispatcher
— Sprint 1.4 Probabilistic reply rate engine
— Sprint 1.5 Stats API, DailyStat rollups

How to use these docs

  1. Product — Start with 00, 16, 17 for prioritization.
  2. Engineering — Use 03–13 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.

Agile workflow (recommended)

Epic (17) → Technical spec (03–13) → Implementation PR → Stats/metrics validation (10)

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