do.dev Documentation Hub

Welcome to the do.dev monorepo documentation. This directory contains all technical documentation organized by category for easy navigation.

🚨 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 Vercel deployment)
4. architecture/CONVEX_MULTI_PROJECT_ARCHITECTURE.md - Multi-Convex architecture (REQUIRED for any Convex work)

📂 Documentation Structure

🏗️ Architecture

System design, architecture decisions, and structural documentation.

• CONVEX_MULTI_PROJECT_ARCHITECTURE.md ⭐ - Multi-project Convex setup
• PROJECT_STRUCTURE.md - Complete project structure
• DUAL_CONVEX_ARCHITECTURE.md - Dual Convex design
• RBAC_IMPLEMENTATION_SUMMARY.md - Role-based access control
• View all architecture docs →

🔐 Authentication

Everything related to authentication, authorization, and user management.

• README.md ⭐ - Authentication overview and index
• CLERK_AUTHENTICATION_ARCHITECTURE.md - Clerk integration
• APP_SPECIFIC_AUTH.md - Multi-tenant authentication
• GOOGLE_AUTH_SETUP.md - OAuth configuration
• View all authentication docs →

🛠️ Development

Development guidelines, standards, and best practices.

• TENETS.md 🎯 - Core development principles (MUST READ)
• GIT_PREFERENCES.md ⚠️ - Git workflow (MUST READ)
• TYPESCRIPT_BEST_PRACTICES.md ⚠️ - TypeScript guidelines
• UI_STANDARDS.md - UI/UX guidelines
• CODEBASE_STATUS.md - Current codebase state
• ROLES.md - User roles documentation
• View all development docs →

🌐 Infrastructure

Deployment, hosting, and infrastructure configuration.

• README.md ⭐ - Infrastructure overview and current status
• TRAEFIK_AUTOMATIC_FAILOVER.md ✅ - ACTIVE: Automatic failover guide (IMPLEMENTED)
• TRAEFIK_MIGRATION_GUIDE.md - Caddy to Traefik migration
• VERCEL_DEPLOYMENT_GUIDE.md - Deployment instructions
• DNS_DESIGN.md - DNS architecture
• MULTI_UPSTREAM_FAILOVER_ARCHITECTURE.md - Failover architecture
• View all infrastructure docs →

✨ Features

Feature-specific documentation and implementation guides.

• LANDING_PAGE_TEMPLATE_GUIDE.md - Landing page system
• SERVER_WIZARD_IMPLEMENTATION.md - Server wizard
• TIPTAP_EDITOR.md - Rich text editor
• ONBOARDING.md - User onboarding flow
• SEO.md - SEO implementation
• View all feature docs →

🗄️ Archive

Older documentation kept for historical reference.

• Contains outdated or superseded documentation
• View archived docs →

🚀 Quick Start Guides

For New Developers

1. Read the Git Preferences
2. Review TypeScript Best Practices
3. Understand the Project Structure
4. Check Codebase Status

For Authentication Work

1. Start with Authentication README
2. Review Convex Multi-Project Architecture
3. Follow relevant setup guides in the authentication folder

For Deployment

1. Read Vercel Deployment Guide
2. Configure environment variables per authentication docs
3. Test TypeScript compilation locally first

📊 Documentation Stats

• Active Documents: 44 (was 52)
• Archived Documents: 16
• Categories: 5 main categories + archive
• Last Major Cleanup: January 26, 2025
• Cleanup Results: Archived 14 outdated documents (27% reduction)
  • Completed migrations: 5 docs
  • Resolved issues: 3 docs
  • Superseded designs: 4 docs
  • Bug reports: 1 doc
  • Duplicate content: 1 doc

🔍 Finding Documentation

By Topic

• Git/GitHub → development/GIT_PREFERENCES.md
• TypeScript → development/TYPESCRIPT_BEST_PRACTICES.md
• Clerk Auth → authentication/
• Convex → architecture/CONVEX_MULTI_PROJECT_ARCHITECTURE.md
• UI Components → development/UI_STANDARDS.md
• Deployment → infrastructure/VERCEL_DEPLOYMENT_GUIDE.md

By Task

• Setting up auth → authentication/README.md
• Adding new landing page → features/LANDING_PAGE_TEMPLATE_GUIDE.md
• Deploying to Vercel → infrastructure/VERCEL_DEPLOYMENT_GUIDE.md
• Understanding roles → development/ROLES.md

💡 Documentation Guidelines

1. Keep docs close to code - Feature docs in feature folders when possible
2. Use clear naming - Descriptive filenames in CAPS_WITH_UNDERSCORES.md
3. Update when changing code - Documentation is part of the PR
4. Archive don't delete - Move outdated docs to archive folder
5. Cross-reference - Link between related documents

---

Remember: Good documentation is as important as good code. Keep it updated! 📚