PROJECT README

Welcome to the project 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. PROJECT_PRD.md - Product Requirements Document (source of truth for project vision)

Project Requirements Document

The PRD is the source of truth for this project. Use it for overall design and thoughts. Keep it updated as the design changes.

• PROJECT_PRD.md ⭐ - Complete product requirements and architecture

📂 Documentation Structure

🔐 Authentication

Everything related to authentication, authorization, and user management.

• README.md ⭐ - Authentication overview and index
• CLERK_SATELLITE_IMPLEMENTATION.md - Clerk satellite domain setup
• CLERK_AUTHENTICATION_ARCHITECTURE.md - Clerk integration architecture
• 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
• ROLES.md - User roles documentation
• View all development docs →

🚀 Quick Start Guides

For New Developers

1. Read the TENETS.md
2. Review Git Preferences
3. Study TypeScript Best Practices
4. Understand the PROJECT_PRD.md

For Authentication Work

1. Start with Authentication README
2. Review Clerk Satellite Implementation
3. Follow relevant setup guides in the authentication folder

For Deployment

1. Review deployment section in PROJECT_PRD.md
2. Configure environment variables per authentication docs
3. Test TypeScript compilation locally first: npx tsc --noEmit --project apps/web/tsconfig.json

🔍 Finding Documentation

By Topic

• Git/GitHub → development/GIT_PREFERENCES.md
• TypeScript → development/TYPESCRIPT_BEST_PRACTICES.md
• Clerk Auth → authentication/
• Convex Backend → PROJECT_PRD.md (Section 7: Technical Architecture)
• UI Components → development/UI_STANDARDS.md
• User Roles → development/ROLES.md

By Task

• Setting up auth → authentication/README.md
• Understanding architecture → PROJECT_PRD.md
• Understanding roles → development/ROLES.md
• Configuring satellite auth → authentication/CLERK_SATELLITE_IMPLEMENTATION.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! 📚