๐ Documentation Index
Navigation Hub: Complete guide to all Uptime Watcher documentation with quick links and descriptions.
Quick linksโ
Getting startedโ
- Developer Quick Start - Get up and running in minutes
- Environment Setup - Complete development environment configuration
- AI Context Guide - Essential context for AI assistants
Core documentationโ
- API Documentation - IPC interfaces and communication patterns
- Troubleshooting Guide - Common issues and solutions
- Testing Guide - Testing setup and practices
๏ฟฝ Documentation structureโ
Root level (/docs/)โ
Essential documentation for developers and contributors:
| Document | Purpose | Audience |
|---|---|---|
| AI-CONTEXT.md | Quick AI onboarding | AI Assistants, New Developers |
| DEVELOPER-QUICK-START.md | Fast developer setup | New Contributors |
| ENVIRONMENT-SETUP.md | Complete environment guide | Developers |
| API-DOCUMENTATION.md | IPC and API reference | Frontend/Backend Developers |
| TROUBLESHOOTING.md | Debug and fix issues | All Developers |
| TECHNOLOGY-EVOLUTION.md | Migration history and rationale | Architects, Contributors |
| DOCUMENTATION-INDEX.md | This index document | All Users |
| ORGANIZATION-SUMMARY.md | Documentation cleanup summary | Maintainers |
๐๏ธ Architecture (/docs/Architecture/)โ
System design, patterns, and architectural decisions:
ADRs (Architecture Decision Records)โ
| Document | Decision | Status |
|---|---|---|
| ADR-001-Repository-Pattern.md | Database access pattern | โ Accepted |
| ADR-002-Event-Driven-Architecture.md | Event system design | โ Accepted |
| ADR-003-Error-Handling-Strategy.md | Error handling approach | โ Accepted |
| ADR-004-Frontend-State-Management.md | Zustand state management | โ Accepted |
| ADR-005-IPC-Communication-Protocol.md | IPC communication design | โ Accepted |
Patterns & standardsโ
| Document | Purpose | Use When |
|---|---|---|
| Development-Patterns-Guide.md | Coding patterns overview | Understanding system patterns |
| tsdoc-standards.md | Documentation standards | Writing code documentation |
Templatesโ
| Template | Purpose | Use When |
|---|---|---|
| Repository-Template.md | Database repository pattern | Adding new data repositories |
| IPC-Handler-Template.md | IPC communication pattern | Adding new IPC endpoints |
| Zustand-Store-Template.md | Frontend state management | Creating new Zustand stores |
๐ Implementation Guides (/docs/Guides/)โ
Step-by-step implementation instructions:
| Guide | Purpose | Complexity |
|---|---|---|
| Renderer-Integration-Guide.md | Renderer/IPC integration | ๐ก Intermediate |
| NEW_MONITOR_TYPE_IMPLEMENTATION.md | Adding monitor types | ๐ก Intermediate |
| UI-Feature-Development-Guide.md | Frontend development | ๐ก Intermediate |
| TESTING.md | Testing setup and practices | ๐ข Beginner |
๐ Historical & Learning (/docs/)โ
Relevant historical context and lessons learned:
| Document | Purpose | Relevance |
|---|---|---|
| TECHNOLOGY-EVOLUTION.md | Complete migration history | Understanding current architecture |
| Fallback-System-Usage-Analysis.md | Migration completion status | Historical context |
| Monitoring-Race-Condition-Solution-Plan.md | Race condition prevention | Architecture 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:
- API-DOCUMENTATION.md - Interface reference
- Architecture/ADRs/ - Design decisions
- Architecture/Templates/ - Code templates
๐จโ๐ป New Developersโ
Start Here: DEVELOPER-QUICK-START.md
- Fast setup and orientation
- Common development tasks
- Essential patterns
Next Steps:
- ENVIRONMENT-SETUP.md - Complete environment
- Architecture/Patterns/Development-Patterns-Guide.md - Coding patterns
- TROUBLESHOOTING.md - When things go wrong
๐๏ธ Backend Developersโ
Focus Areas:
- ADR-001-Repository-Pattern.md - Database patterns
- ADR-002-Event-Driven-Architecture.md - Event system
- Repository-Template.md - Repository implementation
- IPC-Handler-Template.md - IPC communication
๐จ Frontend Developersโ
Focus Areas:
- ADR-004-Frontend-State-Management.md - State management
- UI-Feature-Development-Guide.md - Component development
- Zustand-Store-Template.md - Store creation
- API-DOCUMENTATION.md - IPC interfaces
๐งช QA/Testingโ
Focus Areas:
- TESTING.md - Testing setup and practices
- TROUBLESHOOTING.md - Common issues
- ENVIRONMENT-SETUP.md - Environment configuration
๐ Architects/Tech Leadsโ
Focus Areas:
- Architecture/ADRs/ - All architectural decisions
- Architecture/Patterns/Development-Patterns-Guide.md - System patterns
- Historical documents for evolution understanding
๐ Documentation by Topicโ
๐๏ธ Database & Persistenceโ
- ADR-001-Repository-Pattern.md - Repository pattern design
- Repository-Template.md - Implementation template
- TROUBLESHOOTING.md - Database troubleshooting
๐ Communication & Eventsโ
- ADR-002-Event-Driven-Architecture.md - Event system
- ADR-005-IPC-Communication-Protocol.md - IPC design
- API-DOCUMENTATION.md - Communication interfaces
- RENDERER_INTEGRATION_GUIDE.md - Renderer IPC integration
- IPC-Handler-Template.md - IPC implementation
๐จ Frontend & UIโ
- ADR-004-Frontend-State-Management.md - State management
- UI-Feature-Development-Guide.md - UI development
- Zustand-Store-Template.md - Store patterns
๐ Monitoring & Performanceโ
- NEW_MONITOR_TYPE_IMPLEMENTATION.md - Monitor types
- Monitoring-Race-Condition-Solution-Plan.md - Race condition prevention
- TROUBLESHOOTING.md - Performance tips
โ ๏ธ Error Handling & Debuggingโ
- ADR-003-Error-Handling-Strategy.md - Error strategy
- TROUBLESHOOTING.md - Debug guide
- ENVIRONMENT-SETUP.md - Debug tools
๐ Documentation Maintenanceโ
๐ Contributing to Documentationโ
- Follow TSDoc Standards: Use tsdoc-standards.md
- Update Index: Add new documents to this index
- Cross-Reference: Link related documents
- 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)โ
- AI-CONTEXT.md - Project overview
- DEVELOPER-QUICK-START.md - Setup
- ENVIRONMENT-SETUP.md - Environment
- Architecture/ADRs/ - Design decisions
- API-DOCUMENTATION.md - Interfaces
โก Quick Start (Experienced Developer)โ
- AI-CONTEXT.md - Architecture overview
- DEVELOPER-QUICK-START.md - Setup
- Architecture/Patterns/Development-Patterns-Guide.md - Patterns
๐ Debugging Focusโ
- TROUBLESHOOTING.md - Issues and solutions
- ENVIRONMENT-SETUP.md - Debug tools
- API-DOCUMENTATION.md - Error patterns
๐๏ธ Architecture Deep Diveโ
- Architecture/ADRs/ - All decisions
- Historical documents for evolution context
- 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.