Send.dev Documentation Hub

Welcome to the Send.dev email platform documentation. This directory contains all technical documentation for developing, deploying, and maintaining the Send.dev email sending platform.

🚨 CRITICAL - READ FIRST

Before doing ANY work on this project, you MUST read these documents:

1. TENETS.md - Core development principles that guide every decision
2. development/GIT_PREFERENCES.md - Git workflow (commit = git add -A, NEVER push without permission)
3. development/TYPESCRIPT_BEST_PRACTICES.md - TypeScript guidelines (ESSENTIAL for deployment success)

📂 Documentation Structure

🛠️ Development

Development guidelines, standards, and best practices for the Send.dev platform.

• GIT_PREFERENCES.md ⚠️ - Git workflow (MUST READ)
• TYPESCRIPT_BEST_PRACTICES.md ⚠️ - TypeScript guidelines
• UI_STANDARDS.md - UI/UX guidelines for the web interface

📧 Send Project

Send.dev specific documentation and implementation guides.

• SEND_PROJECT_PRD.md ⭐ - Project requirements and specifications
• SEND_IMPLEMENTATION_PLAN.md - Technical implementation roadmap
• SEND_STATUS_UPDATE.md - Current project status and progress

🚀 Quick Start Guides

For New Developers

1. Read the TENETS - Core development principles
2. Review Git Preferences - Essential workflow
3. Study TypeScript Best Practices - Code quality standards
4. Check Send Project Requirements - Platform overview

For Frontend Development

1. Review UI Standards - Design guidelines
2. Understand the web interface requirements from Send PRD
3. Follow TypeScript guidelines for component development

For Backend Development

1. Review Send Implementation Plan - AWS architecture
2. Follow TypeScript Best Practices for Lambda functions
3. Check Send Status for current implementation state

📊 Project Overview

Send.dev is a modern email sending platform consisting of:

• Web Application (apps/webs/send/) - Landing page and user interface
• AWS Backend (apps/projects/send/aws/) - Email processing infrastructure
• Shared Packages (packages/) - Reusable components and utilities

Core Technologies

• Frontend: Next.js 15, TypeScript, Tailwind CSS, ShadCN UI
• Backend: AWS Lambda, SST, Convex Database
• Email: Resend + AWS SES integration
• Development: Turborepo, Biome.js, pnpm

🔍 Finding Documentation

By Topic

• Git/Development → development/GIT_PREFERENCES.md
• TypeScript → development/TYPESCRIPT_BEST_PRACTICES.md
• UI/Frontend → development/UI_STANDARDS.md
• Send Platform → projects/send/

By Task

• Setting up development → Git Preferences
• Understanding the platform → Send PRD
• Implementation details → Send Implementation Plan
• Current status → Send Status Update

💡 Documentation Guidelines

1. Keep docs current - Update documentation when changing functionality
2. Focus on send.dev - All docs should be relevant to the email platform
3. Clear examples - Include code examples and practical guidance
4. TypeScript first - All code examples should use proper TypeScript
5. Developer focused - Write for developers building and maintaining the platform

🎯 Send.dev Specific Notes

• Platform Focus: Email sending, template management, analytics
• Architecture: Monorepo with web app + AWS backend
• Database: Convex for real-time data and analytics
• Email Services: Resend (primary) + AWS SES (infrastructure)
• Deployment: Vercel (web app) + AWS (backend functions)

---

Remember: This documentation is specifically for the Send.dev email platform. Keep it focused, current, and practical! 📧