trent_larson/daily-notification-plugin
4
0
Fork 0
Code Issues Pull Requests 2 Projects Releases Wiki Activity
Files
ff840ae44dda30cb6a0f7ad0a00839aabffaaeb3
daily-notification-plugin/docs/00-INDEX.md
Matthew Raymer eb1fc9f220 feat(docs): complete P2.6 type safety cleanup and P2.7 system invariants 
P2.6: Type Safety Cleanup
- Replaced 'any' return types in vite-plugin.ts with concrete types (UserConfig, transform return type)
- Documented TypeScript mixin 'any[]' exception in PlatformServiceMixin.ts
- Audit confirmed: zero 'any' in codebase except documented TS mixin limitation
- All external boundaries use 'unknown', all data payloads use 'Record<string, unknown>'

P2.7: System Invariants Documentation
- Created SYSTEM_INVARIANTS.md documenting all 6 enforced invariants
- Added to docs/00-INDEX.md under Policy & Contracts section
- Each invariant includes: What, Why, How, Where

Progress Docs Updates:
- Updated 00-STATUS.md: marked P2.6/P2.7 complete, added type safety invariant note
- Updated 01-CHANGELOG-WORK.md: added 2025-12-22 entries for P2.6/P2.7
- Updated 03-TEST-RUNS.md: added P2.6 type safety audit test run
- Updated P2-DESIGN.md: marked P2.6 acceptance criteria complete
- Updated SYSTEM_INVARIANTS.md: added Type Safety Notes section

Baseline Tag:
- Created v1.0.11-p0-p1.4-p1.5-p2.6-p2.7-complete

TypeScript compilation: ✅ PASSES
Build: ✅ PASSES
CI: ✅ All checks pass
2025-12-22 10:56:00 +00:00

16 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-22
Status: active
Baseline Tag: v1.0.11-p0-p1.4-complete

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

Progress Tracking (Authoritative)

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

Archive & Reference-only

  • docs/_archive/ — Historical artifacts, preserved for audit trail (not part of active doc surface)
  • 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/

Feature-Specific Documentation

Location: docs/

Storage & Database

Native Fetcher

Prefetch & Scheduling

Recovery & Startup

Platform Capabilities

Feature Implementation

Compliance & Operations

Deployment

Utilities

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/
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...

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