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
Jose Olarte III
f58eeda8a7
docs: move 6 root .md files into docs/progress and docs/_archive
...
- Move TODO.md, TODAY_SUMMARY.md, SESSION_RECONSTITUTION.md,
BATCH_A_COMPLETION_SUMMARY.md to docs/progress/
- Move PR_DESCRIPTION.md, MERGE_READY_SUMMARY.md to docs/_archive/
- Update docs/00-INDEX.md with new progress and archive entries
- Note moves in docs/_archive/2025-12-16-consolidation/CONSOLIDATION_SOURCE_MAP.md
Root keeps only README, CHANGELOG, CONTRIBUTING, SECURITY, BUILDING,
ARCHITECTURE, API, USAGE.
2026-03-06 19:27:21 +08:00
Matthew Raymer
1dca99ad17
feat(ios): Extract orchestration helpers to ScheduleHelper
...
Extract iOS orchestration logic from plugin to dedicated helper,
matching Android's ScheduleHelper.kt pattern. This completes the
P2.1 native plugin refactoring for both platforms.
Changes:
- Created DailyNotificationScheduleHelper.swift (192 lines)
- scheduleDailyNotification(): Full orchestration (cancel, clear, save, schedule, prefetch)
- scheduleDualNotification(): Dual scheduling coordination
- clearRolloverState(): Rollover state cleanup helper
- getHealthStatus(): Status combination from multiple sources
- Refactored DailyNotificationPlugin.swift to delegate to helper
- Reduced plugin by 236 lines (1854 → 1807 LOC)
- Total iOS reduction: 11.7% (2047 → 1807 LOC)
- Updated documentation
- docs/progress/00-STATUS.md: Marked verification complete, added helper extraction
- docs/progress/01-CHANGELOG-WORK.md: Added iOS helper extraction entry
- docs/progress/P2.1-REFACTORING-COMPLETE.md: Updated with helper extraction
- docs/00-INDEX.md: Added reference to refactoring summary
Verification:
- TypeScript typecheck: PASS
- Build: PASS
- Tests: PASS (115 tests, 8 test suites)
- External API behavior unchanged
Files changed:
- ios/Plugin/DailyNotificationScheduleHelper.swift (new, 192 lines)
- ios/Plugin/DailyNotificationPlugin.swift (198 insertions, 434 deletions)
- docs/progress/00-STATUS.md (verification status updated)
- docs/progress/01-CHANGELOG-WORK.md (changelog entry added)
- docs/00-INDEX.md (index reference added)
Related:
- Completes P2.1 iOS refactoring (27 methods across 3 batches)
- Matches Android ScheduleHelper.kt pattern
- Total P2.1: 55 methods refactored (28 Android + 27 iOS)
2025-12-24 06:35:03 +00:00
Matthew Raymer
56a89e65b3
docs(p2.1): Fix baseline tag drift and create method-service mapping
...
Fixed baseline tag drift issue:
- docs/00-INDEX.md now references docs/progress/00-STATUS.md as canonical baseline
- docs/progress/00-STATUS.md marked as canonical baseline authority
Created Priority 2.1 mapping and batch planning:
- docs/progress/P2.1-METHOD-SERVICE-MAP.md: Complete method-to-service mapping
- docs/progress/P2.1-BATCH-1.md: First batch (pure delegation, ~15 methods)
- docs/progress/P2.1-BATCH-2.md: Second batch (validation + delegation, ~20 methods)
Batch 1 focuses on read-only operations (lowest risk).
Batch 2 focuses on validation + delegation (medium risk).
Expected reduction: ~1,650-2,000 lines across both platforms.
Verification:
- Baseline authority fixed ✅
- Method mapping complete ✅
- Batch plans created ✅
2025-12-23 10:16:12 +00:00
Matthew Raymer
4a457fa788
feat(docs): P3.4-C Add getting started guide
...
Created docs/GETTING_STARTED.md with:
- Installation instructions (npm/yarn/pnpm)
- Platform setup (iOS and Android)
- Basic usage examples
- Links to authoritative documentation
- Next steps and support resources
Updated docs/00-INDEX.md to link getting started guide.
Verification:
- Documentation created and linked ✅
- Follows established doc structure ✅
2025-12-23 07:26:17 +00:00
Matthew Raymer
bdd2a5d7ac
feat(docs): P3.4-A/B Documentation polish - JSDoc and troubleshooting
...
P3.4-A: Enhanced public API JSDoc
- Enhanced createSchedule() with detailed parameter docs and examples
- Enhanced updateSchedule() with examples and error documentation
- Enhanced deleteSchedule() with error documentation
- Enhanced enableSchedule() with examples
P3.4-B: Created troubleshooting guide
- docs/TROUBLESHOOTING.md with common issues and solutions
- Covers CI failures, packaging, platform tests, build, permissions, recovery, performance
- Linked in docs/00-INDEX.md
Verification:
- TypeScript compiles ✅
- JSDoc generates in .d.ts files ✅
- Documentation created and linked ✅
2025-12-23 07:20:58 +00:00
Matthew Raymer
3a0b9b5692
feat(docs): P3.3-D Add integration examples and common patterns
...
Created:
- docs/examples/QUICK_START.md: Minimal working example with platform setup
- docs/examples/COMMON_PATTERNS.md: Common patterns (error handling, scheduling, recovery)
Updated docs/00-INDEX.md to link examples section.
Verification:
- Documentation created and linked ✅
- Examples follow best practices ✅
2025-12-23 07:18:20 +00:00
Matthew Raymer
21dcc71eae
feat(docs): P3.1-E Add performance characteristics documentation
...
Created docs/PERFORMANCE.md with:
- Expected operation times (scheduling, recovery, database)
- Memory footprint estimates
- Platform-specific considerations
- Measurement methodology
Updated docs/00-INDEX.md to link PERFORMANCE.md.
Verification:
- Documentation created and linked ✅
- Drift guards present ✅
2025-12-23 06:39:39 +00:00
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
Matthew Raymer
c39bd7cec6
docs: Consolidate documentation structure (139 files, zero information loss)
...
Consolidate all markdown documentation into organized structure per
CONSOLIDATION_DIRECTIVE. All files preserved (canonical, merged, or archived).
- docs/integration/ - Integration documentation (7 files)
- docs/platform/ios/ - iOS platform docs (12 files)
- docs/platform/android/ - Android platform docs (9 files)
- docs/testing/ - Testing documentation (15 files)
- docs/design/ - Design & research (5 files)
- docs/ai/ - AI/ChatGPT artifacts (7 files)
- docs/archive/2025-legacy-doc/ - Historical docs (17 files)
- Integration: Root INTEGRATION_GUIDE.md → docs/integration/
- Platform: Separated iOS and Android into platform/ subdirectories
- Testing: Consolidated all testing docs to docs/testing/
- Legacy: Archived entire doc/ directory to archive/
- AI: Moved all ChatGPT artifacts to docs/ai/
- Added docs/00-INDEX.md - Central navigation hub
- Added docs/CONSOLIDATION_SOURCE_MAP.md - Complete audit trail
- Added docs/CONSOLIDATION_COMPLETE.md - Consolidation summary
- Updated README.md with links to documentation index
- All 139 files have destinations (see CONSOLIDATION_SOURCE_MAP.md)
- Zero information loss (all files preserved)
- Archive preserves original structure
- Index provides clear navigation
- 87 files moved/created/updated
- Root-level docs consolidated
- Legacy doc/ directory archived
- Test app docs remain with test apps (indexed)
Ref: CONSOLIDATION_DIRECTIVE
Author: Matthew Raymer
2025-12-18 09:13:18 +00:00