trent_larson/daily-notification-plugin
4
0
Fork 0
Code Issues Pull Requests 2 Projects Releases Wiki Activity
Files
6ad7ff5fe11cc5c5d94f701009c0a250caf32bf8
daily-notification-plugin/docs/00-INDEX.md
Jose Olarte III 6ad7ff5fe1 docs: reorganize docs into subdirs and fix links 
- Keep only index, getting-started, invariants, performance,
  troubleshooting, and file-organization-summary in docs/ root
- Add docs/architecture/ (storage, database interfaces, native fetcher)
- Add docs/deployment/ (deployment-guide, DEPLOYMENT_CHECKLIST)
- Add docs/compliance/ (accessibility, legal, observability)
- Move integration guides and host-app docs to docs/integration/
- Move design/planning and prefetch docs to docs/design/
- Move Android consuming-app and comparison docs to docs/platform/android/
- Move DEPLOYMENT_SUMMARY and TODO-CLASSIFICATION to docs/progress/
- Archive deprecated platform-capability-reference to docs/_archive/
- Point platform-capability links to alarms/01-platform-capability-reference.md
- Update docs/00-INDEX.md with new sections and paths
- Fix cross-references in README, deployment, progress, design, testing,
  and test-app docs
- Remove one-off COMMIT_MESSAGE.txt
2026-03-06 19:51:13 +08:00

19 KiB
Raw Blame History

Documentation Index (Authoritative)

Purpose: Single navigation hub for active documentation; separates contracts, progress truth, guides, and archived/reference-only material.
Owner: Development Team
Last Updated: 2025-12-23
Status: active
Baseline: See docs/progress/00-STATUS.md for current baseline tag

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

Policy & Contracts (Executable)

These are policy-as-code. Any gate (push, release, publish) MUST call ./ci/run.sh.

  • System Invariants: docs/SYSTEM_INVARIANTS.md — Single authoritative document naming and explaining all enforced invariants
  • Local CI Contract: ./ci/run.sh — Single source of truth for CI/release gates
  • Verification / Invariants: ./scripts/verify.sh — Encodes packaging, core-purity, and build invariants
  • CI Usage & Setup: ci/README.md — Local CI documentation
  • Performance Characteristics: docs/PERFORMANCE.md — Performance characteristics and benchmarks
  • Troubleshooting Guide: docs/TROUBLESHOOTING.md — Common issues and solutions

Progress Tracking (Authoritative)

These files define the current truth about project state, decisions, and verification history.

Getting Started

Examples

Archive & Reference-only

  • docs/_archive/ — Historical artifacts, preserved for audit trail (not part of active doc surface)
    • docs/_archive/PR_DESCRIPTION.md, MERGE_READY_SUMMARY.md — One-off PR/merge artifacts (2025-10)
    • docs/_archive/2025-legacy-doc/ — Legacy documentation from 2025
    • docs/_archive/2025-12-16-consolidation/ — 2025-12-16 consolidation artifacts (audit trail)
  • docs/_reference/ — Reference templates (not used by current workflow)
    • docs/_reference/github-actions-ci.yml — GitHub Actions CI template (reference only)

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

Integration Documentation

Location: docs/integration/

Platform-Specific Documentation

iOS

Location: docs/platform/ios/

Android

Location: docs/platform/android/

Testing Documentation

Location: docs/testing/

General Testing

iOS Testing

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:

Design & Research Documentation

Location: docs/design/

Architecture (Storage & Core Tech)

Location: docs/architecture/

Deployment

Location: docs/deployment/

Compliance & Operations

Location: docs/compliance/

Feature-Specific (Integration, Design, Progress)

Integration (docs/integration/)

Design (docs/design/) — plans, prefetch, recovery

Progress (docs/progress/)

Platform — Android (docs/platform/android/)

Platform Capabilities (canonical)

Utilities (meta)

AI / Prompting / Automation Artifacts

Location: docs/ai/

These are derived operational artifacts for AI-assisted development:

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)

Note: Archive documentation is discoverable but not listed in the main navigation. See "Archive & Reference-only" section above for archive locations.

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/
Architecture 4 docs/architecture/
Deployment 2 docs/deployment/
Compliance 3 docs/compliance/
Feature-Specific (integration, design, progress, platform) 14 docs/integration/, docs/design/, docs/progress/, docs/platform/android/
AI Artifacts 7 docs/ai/
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...

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

Index-first rule: New docs must be linked from docs/00-INDEX.md or explicitly placed under _archive/ / _reference/.

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:

Last Updated: 2025-12-22
Maintained By: Development Team

Reference in New Issue View Git Blame Copy Permalink