eb1fc9f220
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
198 lines
6.3 KiB
Markdown
198 lines
6.3 KiB
Markdown
# P1.5 Step 4: Duplicate Consolidation Clusters
|
|
|
|
**Date:** 2025-12-22
|
|
**Status:** 🎯 Ready for Review & Decision
|
|
**Baseline:** `v1.0.11-p0-p1.4-complete`
|
|
|
|
---
|
|
|
|
## Objective
|
|
|
|
Review and consolidate duplicate/superseded documentation with explicit "keep / merge / archive / redirect" decisions per cluster.
|
|
|
|
**Principle:** No information loss — archive or redirect, never delete.
|
|
|
|
---
|
|
|
|
## Cluster 1: Testing Quick References
|
|
|
|
### Files to Review
|
|
|
|
- `docs/testing/QUICK_REFERENCE.md` — Current canonical
|
|
- `docs/testing/QUICK_REFERENCE_V2.md` — Potential duplicate
|
|
|
|
### Decision Process
|
|
|
|
1. **Compare content:**
|
|
- If V2 has unique content → Merge into `QUICK_REFERENCE.md`, then archive V2
|
|
- If V2 is superseded → Archive V2 with pointer in `QUICK_REFERENCE.md`
|
|
|
|
2. **Action:**
|
|
- [ ] Review both files side-by-side
|
|
- [ ] Decide: merge or archive
|
|
- [ ] If merge: Update `QUICK_REFERENCE.md` with V2 content, archive V2
|
|
- [ ] If archive: Move V2 to `docs/_archive/2025-12-16-consolidation/`, add pointer in `QUICK_REFERENCE.md`
|
|
- [ ] Update `docs/00-INDEX.md` (remove V2 from active list if archived)
|
|
|
|
### Authoritative Doc
|
|
|
|
- `docs/testing/QUICK_REFERENCE.md` (keep as canonical)
|
|
|
|
### Expected Outcome
|
|
|
|
- One authoritative quick reference
|
|
- V2 either merged or archived with pointer
|
|
|
|
---
|
|
|
|
## Cluster 2: Integration Refactor Notes
|
|
|
|
### Files to Review
|
|
|
|
- `docs/integration/REFACTOR_NOTES.md` — Current canonical
|
|
- `docs/integration/REFACTOR_NOTES_QUICK_START.md` — Check if duplicate
|
|
- `docs/integration/REFACTOR_ANALYSIS.md` — Check if duplicate
|
|
|
|
### Decision Process
|
|
|
|
1. **Compare content:**
|
|
- If `REFACTOR_NOTES_QUICK_START.md` duplicates `REFACTOR_NOTES.md` → Archive with pointer
|
|
- If `REFACTOR_ANALYSIS.md` duplicates `REFACTOR_NOTES.md` → Archive with pointer
|
|
- If either has unique content → Keep all, add cross-references
|
|
|
|
2. **Action:**
|
|
- [ ] Review all three files for overlap
|
|
- [ ] Identify unique vs duplicate content
|
|
- [ ] If duplicates: Archive with pointer in `REFACTOR_NOTES.md`
|
|
- [ ] If unique: Keep all, add cross-references between files
|
|
- [ ] Update `docs/00-INDEX.md` (remove archived files from active list)
|
|
|
|
### Authoritative Doc
|
|
|
|
- `docs/integration/REFACTOR_NOTES.md` (keep as canonical)
|
|
|
|
### Expected Outcome
|
|
|
|
- One authoritative refactor notes doc (or multiple with clear cross-references)
|
|
- Duplicates archived with pointers
|
|
|
|
---
|
|
|
|
## Cluster 3: iOS Implementation Checklists
|
|
|
|
### Files to Review
|
|
|
|
- `docs/platform/ios/IMPLEMENTATION_CHECKLIST.md` — Current canonical
|
|
- `docs/platform/ios/IOS_IMPLEMENTATION_CHECKLIST.md` — Check if duplicate
|
|
- `docs/platform/ios/IMPLEMENTATION_CHECKLIST_LEGACY.md` — Already marked legacy
|
|
|
|
### Decision Process
|
|
|
|
1. **Compare content:**
|
|
- If `IOS_IMPLEMENTATION_CHECKLIST.md` duplicates `IMPLEMENTATION_CHECKLIST.md` → Archive with pointer
|
|
- If `IOS_IMPLEMENTATION_CHECKLIST.md` has unique content → Merge into `IMPLEMENTATION_CHECKLIST.md`, then archive
|
|
- `IMPLEMENTATION_CHECKLIST_LEGACY.md` → Move to `docs/_archive/2025-legacy-doc/` (already marked legacy)
|
|
|
|
2. **Action:**
|
|
- [ ] Review `IOS_IMPLEMENTATION_CHECKLIST.md` vs `IMPLEMENTATION_CHECKLIST.md`
|
|
- [ ] Decide: merge or archive
|
|
- [ ] Move `IMPLEMENTATION_CHECKLIST_LEGACY.md` to `docs/_archive/2025-legacy-doc/`
|
|
- [ ] Update `docs/00-INDEX.md` (remove archived files from active list)
|
|
|
|
### Authoritative Doc
|
|
|
|
- `docs/platform/ios/IMPLEMENTATION_CHECKLIST.md` (keep as canonical)
|
|
|
|
### Expected Outcome
|
|
|
|
- One authoritative iOS implementation checklist
|
|
- Legacy and duplicate files archived with pointers
|
|
|
|
---
|
|
|
|
## Cluster 4: Deployment Documentation
|
|
|
|
### Files to Review
|
|
|
|
- `docs/deployment-guide.md` — Check if exists
|
|
- `docs/DEPLOYMENT_GUIDE.md` — Check if exists
|
|
- `docs/DEPLOYMENT_CHECKLIST.md` — Keep (complementary)
|
|
- `docs/DEPLOYMENT_SUMMARY.md` — Keep (complementary)
|
|
|
|
### Decision Process
|
|
|
|
1. **Check existence:**
|
|
- If both `deployment-guide.md` and `DEPLOYMENT_GUIDE.md` exist → Compare content
|
|
- If one exists → Keep as canonical
|
|
- If neither exists → Skip this cluster
|
|
|
|
2. **If both exist:**
|
|
- If duplicates → Keep one (prefer `DEPLOYMENT_GUIDE.md` for consistency), archive other
|
|
- If complementary → Keep both, add cross-references
|
|
|
|
3. **Action:**
|
|
- [ ] Check which deployment guide files exist
|
|
- [ ] If both exist: Compare content, decide merge or keep both
|
|
- [ ] If merge: Archive duplicate with pointer
|
|
- [ ] Ensure all deployment docs are cross-referenced
|
|
- [ ] Update `docs/00-INDEX.md` (remove archived files from active list)
|
|
|
|
### Authoritative Doc
|
|
|
|
- `docs/DEPLOYMENT_GUIDE.md` (preferred) or `docs/deployment-guide.md` (if only one exists)
|
|
- `docs/DEPLOYMENT_CHECKLIST.md` (complementary)
|
|
- `docs/DEPLOYMENT_SUMMARY.md` (complementary)
|
|
|
|
### Expected Outcome
|
|
|
|
- One authoritative deployment guide (or multiple with clear cross-references)
|
|
- Duplicates archived with pointers
|
|
|
|
---
|
|
|
|
## Implementation Checklist
|
|
|
|
### Per Cluster
|
|
|
|
- [ ] **Cluster 1:** Testing quick references consolidated
|
|
- [ ] **Cluster 2:** Integration refactor notes consolidated
|
|
- [ ] **Cluster 3:** iOS implementation checklists consolidated
|
|
- [ ] **Cluster 4:** Deployment docs consolidated
|
|
|
|
### After All Clusters
|
|
|
|
- [ ] All archived files moved to appropriate archive directories
|
|
- [ ] All pointers added to authoritative docs
|
|
- [ ] `docs/00-INDEX.md` updated (archived files removed from active list)
|
|
- [ ] `docs/progress/01-CHANGELOG-WORK.md` updated with consolidation summary
|
|
|
|
---
|
|
|
|
## Success Criteria
|
|
|
|
- [ ] No duplicate content in active documentation
|
|
- [ ] All unique content preserved (merged or kept separate with cross-references)
|
|
- [ ] All archived files have clear pointers from authoritative docs
|
|
- [ ] Index reflects only active documentation
|
|
- [ ] No information loss (everything preserved or redirected)
|
|
|
|
---
|
|
|
|
## Risk Mitigation
|
|
|
|
**Risk:** Losing unique content during merge
|
|
**Mitigation:** Review side-by-side before any merge, preserve original in archive if uncertain
|
|
|
|
**Risk:** Creating new sprawl with cross-references
|
|
**Mitigation:** Keep cross-references minimal (1-2 lines), prefer single authoritative doc when possible
|
|
|
|
**Risk:** Breaking internal links
|
|
**Mitigation:** Use redirects/pointers, don't delete files
|
|
|
|
---
|
|
|
|
**Last Updated:** 2025-12-22
|
|
**Status:** Ready for Review & Decision
|
|
**Next Action:** Review each cluster and make explicit decisions
|
|
|