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
This commit is contained in:
Jose Olarte III
@@ -6,7 +6,7 @@
|
||||
**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](./CONSOLIDATION_SOURCE_MAP.md).
|
||||
This index provides organized access to all documentation in the repository. For a complete audit trail of file movements, see [CONSOLIDATION_SOURCE_MAP.md](./_archive/2025-12-16-consolidation/CONSOLIDATION_SOURCE_MAP.md).
|
||||
|
||||
---
|
||||
|
||||
@@ -213,57 +213,77 @@ The alarm system documentation is well-organized and kept in its current locatio
|
||||
|
||||
---
|
||||
|
||||
## Feature-Specific Documentation
|
||||
## Architecture (Storage & Core Tech)
|
||||
|
||||
**Location:** `docs/`
|
||||
**Location:** `docs/architecture/`
|
||||
|
||||
### Storage & Database
|
||||
- **[CROSS_PLATFORM_STORAGE_PATTERN.md](./architecture/CROSS_PLATFORM_STORAGE_PATTERN.md)** - Cross-platform storage pattern
|
||||
- **[DATABASE_INTERFACES.md](./architecture/DATABASE_INTERFACES.md)** - Database interfaces
|
||||
- **[DATABASE_INTERFACES_IMPLEMENTATION.md](./architecture/DATABASE_INTERFACES_IMPLEMENTATION.md)** - Database interfaces implementation
|
||||
- **[NATIVE_FETCHER_CONFIGURATION.md](./architecture/NATIVE_FETCHER_CONFIGURATION.md)** - Native fetcher configuration
|
||||
|
||||
- **[CROSS_PLATFORM_STORAGE_PATTERN.md](./CROSS_PLATFORM_STORAGE_PATTERN.md)** - Cross-platform storage pattern
|
||||
- **[DATABASE_INTERFACES.md](./DATABASE_INTERFACES.md)** - Database interfaces
|
||||
- **[DATABASE_INTERFACES_IMPLEMENTATION.md](./DATABASE_INTERFACES_IMPLEMENTATION.md)** - Database interfaces implementation
|
||||
---
|
||||
|
||||
### Native Fetcher
|
||||
## Deployment
|
||||
|
||||
- **[NATIVE_FETCHER_CONFIGURATION.md](./NATIVE_FETCHER_CONFIGURATION.md)** - Native fetcher configuration
|
||||
**Location:** `docs/deployment/`
|
||||
|
||||
### Prefetch & Scheduling
|
||||
- **[deployment-guide.md](./deployment/deployment-guide.md)** - Deployment guide (primary)
|
||||
- **[DEPLOYMENT_CHECKLIST.md](./deployment/DEPLOYMENT_CHECKLIST.md)** - Deployment checklist
|
||||
|
||||
- **[prefetch-scheduling-diagnosis.md](./prefetch-scheduling-diagnosis.md)** - Prefetch scheduling diagnosis
|
||||
- **[prefetch-scheduling-trace.md](./prefetch-scheduling-trace.md)** - Prefetch scheduling trace
|
||||
---
|
||||
|
||||
### Recovery & Startup
|
||||
## Compliance & Operations
|
||||
|
||||
- **[app-startup-recovery-solution.md](./app-startup-recovery-solution.md)** - App startup recovery solution
|
||||
**Location:** `docs/compliance/`
|
||||
|
||||
### Platform Capabilities
|
||||
- **[accessibility-localization.md](./compliance/accessibility-localization.md)** - Accessibility and localization
|
||||
- **[legal-store-compliance.md](./compliance/legal-store-compliance.md)** - Legal and store compliance
|
||||
- **[observability-dashboards.md](./compliance/observability-dashboards.md)** - Observability dashboards
|
||||
|
||||
- **[platform-capability-reference.md](./platform-capability-reference.md)** - Platform capability reference
|
||||
- **[plugin-requirements-implementation.md](./plugin-requirements-implementation.md)** - Plugin requirements implementation
|
||||
---
|
||||
|
||||
### Feature Implementation
|
||||
## Feature-Specific (Integration, Design, Progress)
|
||||
|
||||
- **[getting-valid-plan-ids.md](./getting-valid-plan-ids.md)** - Getting valid plan IDs
|
||||
- **[host-request-configuration.md](./host-request-configuration.md)** - Host request configuration
|
||||
- **[hydrate-plan-implementation-guide.md](./hydrate-plan-implementation-guide.md)** - Hydrate plan implementation guide
|
||||
- **[user-zero-stars-implementation.md](./user-zero-stars-implementation.md)** - User zero stars implementation
|
||||
### Integration (`docs/integration/`)
|
||||
|
||||
### Compliance & Operations
|
||||
- **[getting-valid-plan-ids.md](./integration/getting-valid-plan-ids.md)** - Getting valid plan IDs
|
||||
- **[host-request-configuration.md](./integration/host-request-configuration.md)** - Host request configuration
|
||||
- **[hydrate-plan-implementation-guide.md](./integration/hydrate-plan-implementation-guide.md)** - Hydrate plan implementation guide
|
||||
- **[user-zero-stars-implementation.md](./integration/user-zero-stars-implementation.md)** - User zero stars implementation
|
||||
- **[capacitor-platform-service-clean-changes.md](./integration/capacitor-platform-service-clean-changes.md)** - Capacitor platform service changes
|
||||
- **[ACTION_PLAN_INTEGRATION_FIXES.md](./integration/ACTION_PLAN_INTEGRATION_FIXES.md)** - Integration fixes action plan
|
||||
|
||||
- **[accessibility-localization.md](./accessibility-localization.md)** - Accessibility and localization
|
||||
- **[legal-store-compliance.md](./legal-store-compliance.md)** - Legal and store compliance
|
||||
- **[observability-dashboards.md](./observability-dashboards.md)** - Observability dashboards
|
||||
### Design (`docs/design/`) — plans, prefetch, recovery
|
||||
|
||||
### Deployment
|
||||
- **[P1.5-CONSOLIDATION-PLAN.md](./design/P1.5-CONSOLIDATION-PLAN.md)** - P1.5 consolidation plan
|
||||
- **[P1.5-STEP4-CLUSTERS.md](./design/P1.5-STEP4-CLUSTERS.md)** - P1.5 step 4 clusters
|
||||
- **[P1.5-STEP4-DECISIONS.md](./design/P1.5-STEP4-DECISIONS.md)** - P1.5 step 4 decisions
|
||||
- **[P2.1-NATIVE-REFACTORING-ANALYSIS.md](./design/P2.1-NATIVE-REFACTORING-ANALYSIS.md)** - P2.1 native refactoring analysis
|
||||
- **[FEEDBACK-RESPONSE-PLAN.md](./design/FEEDBACK-RESPONSE-PLAN.md)** - Feedback response plan
|
||||
- **[prefetch-scheduling-diagnosis.md](./design/prefetch-scheduling-diagnosis.md)** - Prefetch scheduling diagnosis
|
||||
- **[prefetch-scheduling-trace.md](./design/prefetch-scheduling-trace.md)** - Prefetch scheduling trace
|
||||
- **[app-startup-recovery-solution.md](./design/app-startup-recovery-solution.md)** - App startup recovery solution
|
||||
- **[plugin-requirements-implementation.md](./design/plugin-requirements-implementation.md)** - Plugin requirements implementation
|
||||
|
||||
- **[deployment-guide.md](./deployment-guide.md)** - Deployment guide (primary)
|
||||
- **[DEPLOYMENT_CHECKLIST.md](./DEPLOYMENT_CHECKLIST.md)** - Deployment checklist
|
||||
- **[DEPLOYMENT_SUMMARY.md](./DEPLOYMENT_SUMMARY.md)** - Deployment summary
|
||||
### Progress (`docs/progress/`)
|
||||
|
||||
### Utilities
|
||||
- **[DEPLOYMENT_SUMMARY.md](./progress/DEPLOYMENT_SUMMARY.md)** - Deployment summary
|
||||
- **[TODO-CLASSIFICATION.md](./progress/TODO-CLASSIFICATION.md)** - TODO classification
|
||||
|
||||
### Platform — Android (`docs/platform/android/`)
|
||||
|
||||
- **[CONSUMING_APP_ANDROID_NOTES.md](./platform/android/CONSUMING_APP_ANDROID_NOTES.md)** - Consuming app Android notes
|
||||
- **[CONSUMING_APP_OPTIONAL_ANDROID_ID_CLEANUP.md](./platform/android/CONSUMING_APP_OPTIONAL_ANDROID_ID_CLEANUP.md)** - Optional Android ID cleanup
|
||||
- **[TIMESAFARI_ANDROID_COMPARISON.md](./platform/android/TIMESAFARI_ANDROID_COMPARISON.md)** - TimeSafari Android comparison
|
||||
|
||||
### Platform Capabilities (canonical)
|
||||
|
||||
- **[01-platform-capability-reference.md](./alarms/01-platform-capability-reference.md)** - Platform capability reference (canonical; deprecated root copy archived in `_archive/`)
|
||||
|
||||
### Utilities (meta)
|
||||
|
||||
- **[file-organization-summary.md](./file-organization-summary.md)** - File organization summary
|
||||
- **[capacitor-platform-service-clean-changes.md](./capacitor-platform-service-clean-changes.md)** - Capacitor platform service changes
|
||||
|
||||
---
|
||||
|
||||
@@ -287,7 +307,7 @@ These are derived operational artifacts for AI-assisted development:
|
||||
|
||||
**Location:** `docs/archive/2025-legacy-doc/`
|
||||
|
||||
Historical documentation preserved verbatim. See [CONSOLIDATION_SOURCE_MAP.md](./CONSOLIDATION_SOURCE_MAP.md) for complete archive listing.
|
||||
Historical documentation preserved verbatim. See [CONSOLIDATION_SOURCE_MAP.md](./_archive/2025-12-16-consolidation/CONSOLIDATION_SOURCE_MAP.md) for complete archive listing.
|
||||
|
||||
**Notable archived content:**
|
||||
- Historical directives (`doc/directives/`)
|
||||
@@ -312,9 +332,11 @@ Historical documentation preserved verbatim. See [CONSOLIDATION_SOURCE_MAP.md](.
|
||||
| **Testing** | 13 | `docs/testing/` |
|
||||
| **Alarms** | 11 | `docs/alarms/` |
|
||||
| **Design & Research** | 5 | `docs/design/` |
|
||||
| **Feature-Specific** | 18 | `docs/` |
|
||||
| **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/` |
|
||||
| **Deployment** | 3 | `docs/` |
|
||||
| **Test Apps** | 20+ | `test-apps/*/` |
|
||||
| **Archive** | 29 | `docs/archive/2025-legacy-doc/` |
|
||||
|
||||
@@ -339,7 +361,7 @@ Historical documentation preserved verbatim. See [CONSOLIDATION_SOURCE_MAP.md](.
|
||||
- **Test on Android** → See [Android Test App Docs](../test-apps/android-test-app/docs/)
|
||||
- **Understand alarms** → Browse [Alarms Documentation](./alarms/)
|
||||
- **Troubleshoot** → Check platform-specific troubleshooting guides
|
||||
- **Deploy** → See [Deployment Guide](./deployment-guide.md)
|
||||
- **Deploy** → See [Deployment Guide](./deployment/deployment-guide.md)
|
||||
|
||||
### By Platform
|
||||
|
||||
@@ -366,12 +388,12 @@ 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](./CONSOLIDATION_SOURCE_MAP.md) if consolidating
|
||||
4. Update [CONSOLIDATION_SOURCE_MAP.md](./_archive/2025-12-16-consolidation/CONSOLIDATION_SOURCE_MAP.md) if consolidating
|
||||
|
||||
### Consolidation Reference
|
||||
|
||||
For complete consolidation audit trail, see:
|
||||
- **[CONSOLIDATION_SOURCE_MAP.md](./CONSOLIDATION_SOURCE_MAP.md)** - Complete file mapping
|
||||
- **[CONSOLIDATION_SOURCE_MAP.md](./_archive/2025-12-16-consolidation/CONSOLIDATION_SOURCE_MAP.md)** - Complete file mapping
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user