Skip to main content

📚 Documentation Index

Navigation Hub: Complete guide to all Uptime Watcher documentation with quick links and descriptions.

🎯 Quick Links​

🚀 Getting Started​

📖 Core Documentation​

🗂️ Documentation Structure​

📁 Root Level (/docs/)​

Essential documentation for developers and contributors:

DocumentPurposeAudience
AI-CONTEXT.mdQuick AI onboardingAI Assistants, New Developers
DEVELOPER-QUICK-START.mdFast developer setupNew Contributors
ENVIRONMENT-SETUP.mdComplete environment guideDevelopers
API-DOCUMENTATION.mdIPC and API referenceFrontend/Backend Developers
TROUBLESHOOTING.mdDebug and fix issuesAll Developers
TECHNOLOGY-EVOLUTION.mdMigration history and rationaleArchitects, Contributors
DOCUMENTATION-INDEX.mdThis index documentAll Users
ORGANIZATION-SUMMARY.mdDocumentation cleanup summaryMaintainers

🏗️ Architecture (/docs/Architecture/)​

System design, patterns, and architectural decisions:

ADRs (Architecture Decision Records)​

DocumentDecisionStatus
ADR-001-Repository-Pattern.mdDatabase access pattern✅ Accepted
ADR-002-Event-Driven-Architecture.mdEvent system design✅ Accepted
ADR-003-Error-Handling-Strategy.mdError handling approach✅ Accepted
ADR-004-Frontend-State-Management.mdZustand state management✅ Accepted
ADR-005-IPC-Communication-Protocol.mdIPC communication design✅ Accepted

Patterns & Standards​

DocumentPurposeUse When
Development-Patterns-Guide.mdCoding patterns overviewUnderstanding system patterns
TSDoc-Standards.mdDocumentation standardsWriting code documentation

Templates​

TemplatePurposeUse When
Repository-Template.mdDatabase repository patternAdding new data repositories
IPC-Handler-Template.mdIPC communication patternAdding new IPC endpoints
Zustand-Store-Template.mdFrontend state managementCreating new Zustand stores

📖 Implementation Guides (/docs/Guides/)​

Step-by-step implementation instructions:

GuidePurposeComplexity
NEW_MONITOR_TYPE_IMPLEMENTATION.mdAdding monitor types🟡 Intermediate
UI-Feature-Development-Guide.mdFrontend development🟡 Intermediate
TESTING.mdTesting setup and practices🟢 Beginner

📝 Historical & Learning (/docs/)​

Relevant historical context and lessons learned:

DocumentPurposeRelevance
TECHNOLOGY-EVOLUTION.mdComplete migration historyUnderstanding current architecture
Fallback-System-Usage-Analysis.mdMigration completion statusHistorical context
Monitoring-Race-Condition-Solution-Plan.mdRace condition preventionArchitecture understanding

🎯 Documentation by Role​

🤖 AI Assistants​

Start Here: AI-CONTEXT.md

  • Complete project overview and patterns
  • Common development tasks
  • Architecture constraints and guidelines

Follow Up:

👨‍💻 New Developers​

Start Here: DEVELOPER-QUICK-START.md

  • Fast setup and orientation
  • Common development tasks
  • Essential patterns

Next Steps:

🏗️ Backend Developers​

Focus Areas:

🎨 Frontend Developers​

Focus Areas:

🧪 QA/Testing​

Focus Areas:

📐 Architects/Tech Leads​

Focus Areas:

🔍 Documentation by Topic​

🗃️ Database & Persistence​

🔗 Communication & Events​

🎨 Frontend & UI​

🔍 Monitoring & Performance​

⚠️ Error Handling & Debugging​

📋 Documentation Maintenance​

📝 Contributing to Documentation​

  1. Follow TSDoc Standards: Use TSDoc-Standards.md
  2. Update Index: Add new documents to this index
  3. Cross-Reference: Link related documents
  4. Keep Current: Update outdated information

🔄 Documentation Review Process​

  • Quarterly: Review all ADRs for relevance
  • Monthly: Update troubleshooting with new issues
  • Per Release: Update API documentation
  • As Needed: Update guides when patterns change

📊 Documentation Metrics​

Track documentation health:

  • Link validity (automated via GitHub Actions)
  • Documentation coverage per feature
  • Outdated documentation identification
  • User feedback on documentation quality

🎯 Recommended Reading Paths​

📚 Complete Onboarding (New Team Member)​

  1. AI-CONTEXT.md - Project overview
  2. DEVELOPER-QUICK-START.md - Setup
  3. ENVIRONMENT-SETUP.md - Environment
  4. Architecture/ADRs/ - Design decisions
  5. API-DOCUMENTATION.md - Interfaces

⚡ Quick Start (Experienced Developer)​

  1. AI-CONTEXT.md - Architecture overview
  2. DEVELOPER-QUICK-START.md - Setup
  3. Architecture/Patterns/Development-Patterns-Guide.md - Patterns

🐛 Debugging Focus​

  1. TROUBLESHOOTING.md - Issues and solutions
  2. ENVIRONMENT-SETUP.md - Debug tools
  3. API-DOCUMENTATION.md - Error patterns

🏗️ Architecture Deep Dive​

  1. Architecture/ADRs/ - All decisions
  2. Historical documents for evolution context
  3. Architecture/Patterns/Development-Patterns-Guide.md - Implementation patterns

💡 Navigation Tip: Use Ctrl+F (Cmd+F on Mac) to quickly find specific topics or use the GitHub search functionality for cross-document searches.