daily-notification-plugin/docs/00-INDEX.md

Documentation Index

Last Updated: 2025-12-16
Purpose: Central navigation hub for all project documentation

This index provides organized access to all documentation in the repository. For a complete audit trail of file movements, see CONSOLIDATION_SOURCE_MAP.md.

---

Quick Start

New to the project? Start here:

1. README.md - Project overview and getting started
2. ARCHITECTURE.md - System architecture
3. docs/integration/QUICK_START.md - Quick integration guide
4. BUILDING.md - Build instructions

---

Core Documentation

Project Foundation

• README.md - Main project entry point
• ARCHITECTURE.md - System architecture and design
• BUILDING.md - Build instructions and setup
• CHANGELOG.md - Version history
• CONTRIBUTING.md - Contribution guidelines
• SECURITY.md - Security documentation
• API.md - API reference
• USAGE.md - Usage guide

---

Integration Documentation

Location: docs/integration/

• INTEGRATION_GUIDE.md - Complete integration guide
• QUICK_START.md - Quick integration path
• TROUBLESHOOTING.md - Integration troubleshooting
• CHECKLIST.md - Integration checklist
• REFACTOR_NOTES.md - Integration refactor context and analysis

---

Platform-Specific Documentation

iOS

Location: docs/platform/ios/

• IMPLEMENTATION_CHECKLIST.md - iOS implementation checklist
• IMPLEMENTATION_DIRECTIVE.md - iOS implementation directive
• DOCUMENTATION_REVIEW.md - Documentation review
• CORE_DATA_MIGRATION.md - Core Data migration guide
• RECOVERY_SCENARIO_MAPPING.md - Recovery scenario mapping
• ROLLOVER_EDGE_CASES.md - Rollover edge cases
• ROLLOVER_IMPLEMENTATION_REVIEW.md - Rollover implementation review
• ROLLOVER_QA.md - Rollover Q&A
• TROUBLESHOOTING.md - iOS troubleshooting guide
• PREFETCH_GLOSSARY.md - Prefetch terminology

Android

Location: docs/platform/android/

• IMPLEMENTATION_DIRECTIVE.md - Primary Android implementation directive
• PHASE1_DIRECTIVE.md - Phase 1 directive
• PHASE2_DIRECTIVE.md - Phase 2 directive
• PHASE3_DIRECTIVE.md - Phase 3 directive
• ALARM_PERSISTENCE_DIRECTIVE.md - Alarm persistence directive
• APP_ANALYSIS.md - Android app analysis
• APP_IMPROVEMENT_PLAN.md - App improvement plan
• BUILDING.md - Android build guide
• DATABASE_CONSOLIDATION_PLAN.md - Database consolidation plan

---

Testing Documentation

Location: docs/testing/

General Testing

• COMPREHENSIVE_GUIDE.md - Comprehensive testing guide
• QUICK_REFERENCE.md - Testing quick reference
• MANUAL_SMOKE_TEST.md - Manual smoke test procedures
• NOTIFICATION_PROCEDURES.md - Notification testing procedures
• REBOOT_PROCEDURE.md - Reboot testing procedure
• BOOT_RECEIVER_GUIDE.md - Boot receiver testing guide
• EMULATOR_GUIDE.md - Standalone emulator guide
• LOCALHOST_GUIDE.md - Localhost testing guide

iOS Testing

• IOS_PHASE1_TESTING_GUIDE.md - iOS Phase 1 testing guide
• IOS_TEST_APP_SETUP.md - iOS test app setup
• IOS_LOGGING_GUIDE.md - iOS logging guide
• IOS_PREFETCH_TESTING.md - iOS prefetch testing
• IOS_TEST_APP_REQUIREMENTS.md - iOS test app requirements

Test App Documentation

Test app-specific documentation remains with the test apps but is indexed here:

Android Test App:

• test-apps/android-test-app/docs/ - Android test app documentation
• test-apps/android-test-app/docs/PHASE1_TEST0_GOLDEN.md - Phase 1 Test 0 golden reference
• test-apps/android-test-app/docs/PHASE1_TEST1_GOLDEN.md - Phase 1 Test 1 golden reference

iOS Test App:

• test-apps/ios-test-app/README.md - iOS test app README
• test-apps/ios-test-app/BUILD_NOTES.md - Build notes
• test-apps/ios-test-app/COMPILATION_SUMMARY.md - Compilation summary

Daily Notification Test App:

• test-apps/daily-notification-test/README.md - Test app README
• test-apps/daily-notification-test/docs/ - Test app documentation

---

Alarm System Documentation

Location: docs/alarms/

The alarm system documentation is well-organized and kept in its current location:

• 000-UNIFIED-ALARM-DIRECTIVE.md - Unified alarm directive
• 01-platform-capability-reference.md - Platform capability reference
• 02-plugin-behavior-exploration.md - Plugin behavior exploration
• 03-plugin-requirements.md - Plugin requirements
• ACTIVATION-GUIDE.md - Activation guide
• PHASE1-EMULATOR-TESTING.md - Phase 1 emulator testing
• PHASE1-VERIFICATION.md - Phase 1 verification
• PHASE2-EMULATOR-TESTING.md - Phase 2 emulator testing
• PHASE2-VERIFICATION.md - Phase 2 verification
• PHASE3-EMULATOR-TESTING.md - Phase 3 emulator testing
• PHASE3-VERIFICATION.md - Phase 3 verification

---

Design & Research Documentation

Location: docs/design/

• STARRED_PROJECTS_POLLING_IMPLEMENTATION.md - Starred projects polling implementation
• exploration-findings-initial.md - Initial exploration findings
• explore-alarm-behavior-directive.md - Alarm behavior exploration directive
• improve-alarm-directives.md - Alarm improvement directives
• plugin-behavior-exploration-template.md - Plugin behavior exploration template

---

Feature-Specific Documentation

Location: docs/

Storage & Database

• CROSS_PLATFORM_STORAGE_PATTERN.md - Cross-platform storage pattern
• DATABASE_INTERFACES.md - Database interfaces
• DATABASE_INTERFACES_IMPLEMENTATION.md - Database interfaces implementation

Native Fetcher

• NATIVE_FETCHER_CONFIGURATION.md - Native fetcher configuration

Prefetch & Scheduling

• prefetch-scheduling-diagnosis.md - Prefetch scheduling diagnosis
• prefetch-scheduling-trace.md - Prefetch scheduling trace

Recovery & Startup

• app-startup-recovery-solution.md - App startup recovery solution

Platform Capabilities

• platform-capability-reference.md - Platform capability reference
• plugin-requirements-implementation.md - Plugin requirements implementation

Feature Implementation

• getting-valid-plan-ids.md - Getting valid plan IDs
• host-request-configuration.md - Host request configuration
• hydrate-plan-implementation-guide.md - Hydrate plan implementation guide
• user-zero-stars-implementation.md - User zero stars implementation

Compliance & Operations

• accessibility-localization.md - Accessibility and localization
• legal-store-compliance.md - Legal and store compliance
• observability-dashboards.md - Observability dashboards

Deployment

• DEPLOYMENT_GUIDE.md - Deployment guide
• DEPLOYMENT_CHECKLIST.md - Deployment checklist
• DEPLOYMENT_SUMMARY.md - Deployment summary

Utilities

• file-organization-summary.md - File organization summary
• capacitor-platform-service-clean-changes.md - Capacitor platform service changes

---

AI / Prompting / Automation Artifacts

Location: docs/ai/

These are derived operational artifacts for AI-assisted development:

• AI_INTEGRATION_GUIDE.md - AI integration guide
• chatgpt-analysis-guide.md - ChatGPT analysis guide
• chatgpt-assessment-package.md - ChatGPT assessment package
• chatgpt-files-overview.md - ChatGPT files overview
• chatgpt-improvement-directives-template.md - Improvement directives template
• code-summary-for-chatgpt.md - Code summary for ChatGPT
• key-code-snippets-for-chatgpt.md - Key code snippets for ChatGPT

---

Archive Documentation

Location: docs/archive/2025-legacy-doc/

Historical documentation preserved verbatim. See CONSOLIDATION_SOURCE_MAP.md for complete archive listing.

Notable archived content:

• Historical directives (doc/directives/)
• Phase 1 summaries and analysis
• Historical build and integration notes
• Test app setup guides (superseded by current testing docs)

---

Document Map by Category

By Purpose

Category	Count	Location
Core Documentation	8	Root + docs/
Integration	5	docs/integration/
Platform (iOS)	10	docs/platform/ios/
Platform (Android)	9	docs/platform/android/
Testing	13	docs/testing/
Alarms	11	docs/alarms/
Design & Research	5	docs/design/
Feature-Specific	18	docs/
AI Artifacts	7	docs/ai/
Deployment	3	docs/
Test Apps	20+	test-apps/*/
Archive	29	docs/archive/2025-legacy-doc/

By Status

• Canonical (Active): ~95 files
• Merged: ~15 files (content preserved in canonical docs)
• Archived: ~29 files (preserved verbatim)

---

Finding Documentation

By Task

I want to...

• Integrate the plugin → Start with Integration Guide
• Build the project → See BUILDING.md
• Understand architecture → Read ARCHITECTURE.md
• Test on iOS → See iOS Testing Guide
• Test on Android → See Android Test App Docs
• Understand alarms → Browse Alarms Documentation
• Troubleshoot → Check platform-specific troubleshooting guides
• Deploy → See Deployment Guide

By Platform

• iOS → docs/platform/ios/
• Android → docs/platform/android/
• Cross-Platform → docs/alarms/, docs/integration/

By Phase

• Phase 1 → Platform-specific Phase 1 directives
• Phase 2 → Platform-specific Phase 2 directives
• Phase 3 → Platform-specific Phase 3 directives

---

Maintenance

Updating This Index

When adding new documentation:

1. Place file in appropriate category directory
2. Add entry to this index in the correct section
3. Update the "Document Map by Category" table if needed
4. Update CONSOLIDATION_SOURCE_MAP.md if consolidating

Consolidation Reference

For complete consolidation audit trail, see:

• CONSOLIDATION_SOURCE_MAP.md - Complete file mapping

---

Last Updated: 2025-12-16
Maintained By: Documentation Team