Skip to content

Lokie-ree/edcoachai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

EdCoach AI Documentation

Last Updated: September 17, 2025
Purpose: Single navigation hub for all EdCoach AI project information
Structure: Optimized for maximum maintainability with minimum overhead


🎯 Core Documentation (START HERE)

πŸ“– CONTEXT.md - Master Context (Single Source of Truth)

Everything you need to know about EdCoach AI in one comprehensive file (650+ lines):

  • 🎯 Project Foundation: Mission, continuous growth loop, current status (87% complete)
  • πŸ‘₯ User Context: Detailed personas (Sarah & Michael), transformation focus, competitive differentiation
  • πŸ—οΈ Technical Context: Complete architecture, data models, performance standards, security
  • 🎨 Design Context: Typography system, color palette, component architecture, accessibility standards
  • πŸ”„ Core Workflow: Detailed 5-phase continuous growth loop with entry points and outcomes
  • πŸš€ Strategic Priorities: P0/P1/P2 roadmap with problems, solutions, and impact assessment
  • πŸ”’ Business Model: Revenue strategy, pricing tiers, go-to-market, competitive positioning
  • πŸ“Š Success Framework: KPIs, quality standards, maintenance guidelines

🎨 brand-guidelines.md - Brand Identity & Visual System

Complete brand system with logo strategy and implementation:

  • 🎨 Logo System: Hybrid approach with 3 strategic variations (Primary/Storytelling/Innovation)
  • 🎯 Brand Identity: Mission-driven personality and competitive positioning
  • πŸ“± Mobile Optimization: iPad coaching and iPhone reflection workflows
  • 🎨 Color Palette: Professional Growth Palette with semantic usage guidelines
  • πŸ“‹ Implementation: Asset organization, usage guidelines, technical specifications

πŸ€– Agent Coordination System

πŸ‘₯ agents/README.md - 5-Agent Development Workflow

Overview of coordinated development process and quality standards.

Specialized Agent Instructions

  • 🎯 Product Manager - Business strategy, user experience, backlog prioritization
  • πŸ—οΈ System Architect - Technical architecture, API contracts, system design
  • βš™οΈ Backend Engineer - Convex implementation, AI integration, data management
  • 🎨 Frontend Engineer - Next.js/React implementation, UI development
  • 🎨 UX Designer - User experience design, design system, accessibility

Note: All agent files are lightweight and reference the Master Context for comprehensive project information.


πŸ“ Archive Documentation

Legacy Documentation (Historical Reference)

Note: This information has been consolidated into CONTEXT.md and brand-guidelines.md for easier maintenance. Archive remains for historical reference and detailed specifications.


πŸš€ Quick Start by Role

New to the Project?

  1. Start with: CONTEXT.md - Read the entire file (15-20 minutes)
  2. Brand system: brand-guidelines.md for visual identity
  3. Role-specific: Check your agent file for detailed responsibilities
  4. Development: See .cursorrules in project root for coding patterns

For Product Managers

For System Architects

For UX/UI Designers

For Backend Engineers

For Frontend Engineers


πŸ” Finding Information

Project Understanding

β†’ CONTEXT.md - Complete project context in single file

Visual Identity & Branding

β†’ brand-guidelines.md - Logo system, colors, implementation

Agent Coordination

β†’ agents/README.md - Development workflow and handoff patterns

Development Patterns

β†’ .cursorrules in project root - Quick reference for coding standards

Historical Context

β†’ archive/ - Legacy documentation for detailed historical reference


πŸ“ Maintenance Excellence

Documentation Ownership

  • CONTEXT.md: Product Manager (lead) + all senior roles
  • brand-guidelines.md: UX Designer + Product Manager
  • Agent files: Respective role owners
  • This README: System Architect

Update Process

  • Context Changes: Update CONTEXT.md (single source of truth)
  • Brand Changes: Update brand-guidelines.md
  • Process Changes: Update agents/README.md
  • Role Changes: Update specific agent files

Quality Standards

  • Single Source: No information duplication across files
  • Clear Navigation: Every piece of information has a clear location
  • Version Control: Track all changes with proper commit messages
  • Review Cycle: Quarterly comprehensive review, monthly tactical updates

πŸ“Š Documentation Structure Benefits

Maximum Maintainability Achieved

  • 2 Core Files: CONTEXT.md + brand-guidelines.md contain 95% of needed information
  • 5 Agent Files: Lightweight, role-specific instructions that reference core files
  • 1 Navigation Hub: This README provides clear entry points
  • Archive System: Legacy docs preserved but not cluttering active workspace

Maintenance Overhead Reduction

Metric Before After Improvement
Active Files 15+ files 8 files 47% reduction
Update Points Multiple 2 master files 85% reduction
Navigation Complexity High Single hub Clear path
Information Duplication Significant Zero 100% elimination

This documentation structure provides maximum maintainability with minimum overhead. All project context lives in clearly organized files with zero duplication and clear ownership.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages