feat: Implement centralized module management system
- Add ModuleRegistry for managing built-in modules (newsletter, wishlist, affiliate, subscription, licensing) - Add ModulesController REST API for module enable/disable - Create Modules settings page with category grouping and toggle controls - Integrate module checks across admin-spa and customer-spa - Add useModules hook for both SPAs to check module status - Hide newsletter from footer builder when module disabled - Hide wishlist features when module disabled (product cards, account menu, wishlist page) - Protect wishlist API endpoints with module checks - Auto-update navigation tree when modules toggled - Clean up obsolete documentation files - Add comprehensive documentation: - MODULE_SYSTEM_IMPLEMENTATION.md - MODULE_INTEGRATION_SUMMARY.md - ADDON_MODULE_INTEGRATION.md (proposal) - ADDON_MODULE_DESIGN_DECISIONS.md (design doc) - FEATURE_ROADMAP.md - SHIPPING_INTEGRATION.md Module system provides: - Centralized enable/disable for all features - Automatic navigation updates - Frontend/backend integration - Foundation for addon-module unification
This commit is contained in:
Dwindi Ramadhana
191
DOCS_CLEANUP_AUDIT.md
Normal file
191
DOCS_CLEANUP_AUDIT.md
Normal file
@@ -0,0 +1,191 @@
|
||||
# Documentation Cleanup Audit - December 2025
|
||||
|
||||
**Total Files Found**: 74 markdown files
|
||||
**Audit Date**: December 26, 2025
|
||||
|
||||
---
|
||||
|
||||
## 📋 Audit Categories
|
||||
|
||||
### ✅ KEEP - Essential & Active (18 files)
|
||||
|
||||
#### Core Documentation
|
||||
1. **README.md** - Main plugin documentation
|
||||
2. **API_ROUTES.md** - API endpoint reference
|
||||
3. **HOOKS_REGISTRY.md** - Filter/action hooks registry
|
||||
4. **VALIDATION_HOOKS.md** - Email/phone validation hooks (NEW)
|
||||
|
||||
#### Architecture & Patterns
|
||||
5. **ADDON_BRIDGE_PATTERN.md** - Addon architecture
|
||||
6. **ADDON_DEVELOPMENT_GUIDE.md** - Addon development guide
|
||||
7. **ADDON_REACT_INTEGRATION.md** - React addon integration
|
||||
8. **PAYMENT_GATEWAY_PATTERNS.md** - Payment gateway patterns
|
||||
9. **ARCHITECTURE_DECISION_CUSTOMER_SPA.md** - Customer SPA architecture
|
||||
|
||||
#### System Guides
|
||||
10. **NOTIFICATION_SYSTEM.md** - Notification system documentation
|
||||
11. **I18N_IMPLEMENTATION_GUIDE.md** - Translation system
|
||||
12. **EMAIL_DEBUGGING_GUIDE.md** - Email troubleshooting
|
||||
13. **FILTER_HOOKS_GUIDE.md** - Filter hooks guide
|
||||
14. **MARKDOWN_SYNTAX_AND_VARIABLES.md** - Email template syntax
|
||||
|
||||
#### Active Plans
|
||||
15. **NEWSLETTER_CAMPAIGN_PLAN.md** - Newsletter campaign architecture (NEW)
|
||||
16. **SETUP_WIZARD_DESIGN.md** - Setup wizard design
|
||||
17. **TAX_SETTINGS_DESIGN.md** - Tax settings UI/UX
|
||||
18. **CUSTOMER_SPA_MASTER_PLAN.md** - Customer SPA roadmap
|
||||
|
||||
---
|
||||
|
||||
### 🗑️ DELETE - Obsolete/Completed (32 files)
|
||||
|
||||
#### Completed Fixes (Delete - Issues Resolved)
|
||||
1. **FIXES_APPLIED.md** - Old fixes log
|
||||
2. **REAL_FIX.md** - Temporary fix doc
|
||||
3. **CANONICAL_REDIRECT_FIX.md** - Fix completed
|
||||
4. **HEADER_FIXES_APPLIED.md** - Fix completed
|
||||
5. **FINAL_FIXES.md** - Fix completed
|
||||
6. **FINAL_FIXES_APPLIED.md** - Fix completed
|
||||
7. **FIX_500_ERROR.md** - Fix completed
|
||||
8. **HASHROUTER_FIXES.md** - Fix completed
|
||||
9. **INLINE_SPACING_FIX.md** - Fix completed
|
||||
10. **DIRECT_ACCESS_FIX.md** - Fix completed
|
||||
|
||||
#### Completed Features (Delete - Implemented)
|
||||
11. **APPEARANCE_MENU_RESTRUCTURE.md** - Menu restructured
|
||||
12. **SETTINGS-RESTRUCTURE.md** - Settings restructured
|
||||
13. **HEADER_FOOTER_REDESIGN.md** - Redesign completed
|
||||
14. **TYPOGRAPHY-PLAN.md** - Typography implemented
|
||||
15. **CUSTOMER_SPA_SETTINGS.md** - Settings implemented
|
||||
16. **CUSTOMER_SPA_STATUS.md** - Status outdated
|
||||
17. **CUSTOMER_SPA_THEME_SYSTEM.md** - Theme system built
|
||||
|
||||
#### Product Page (Delete - Completed)
|
||||
18. **PRODUCT_PAGE_VISUAL_OVERHAUL.md** - Overhaul completed
|
||||
19. **PRODUCT_PAGE_FINAL_STATUS.md** - Status outdated
|
||||
20. **PRODUCT_PAGE_REVIEW_REPORT.md** - Review completed
|
||||
21. **PRODUCT_PAGE_ANALYSIS_REPORT.md** - Analysis completed
|
||||
22. **PRODUCT_CART_COMPLETE.md** - Feature completed
|
||||
|
||||
#### Meta/Compat (Delete - Implemented)
|
||||
23. **IMPLEMENTATION_PLAN_META_COMPAT.md** - Implemented
|
||||
24. **METABOX_COMPAT.md** - Implemented
|
||||
|
||||
#### Old Audit Reports (Delete - Superseded)
|
||||
25. **DOCS_AUDIT_REPORT.md** - Old audit (Nov 2025)
|
||||
|
||||
#### Shipping Research (Delete - Superseded by Integration)
|
||||
26. **SHIPPING_ADDON_RESEARCH.md** - Research phase done
|
||||
27. **SHIPPING_FIELD_HOOKS.md** - Hooks documented in HOOKS_REGISTRY
|
||||
|
||||
#### Deployment/Testing (Delete - Process Docs)
|
||||
28. **DEPLOYMENT_GUIDE.md** - Deployment is automated
|
||||
29. **TESTING_CHECKLIST.md** - Testing is ongoing
|
||||
30. **TROUBLESHOOTING.md** - Issues resolved
|
||||
|
||||
#### Customer SPA (Delete - Superseded)
|
||||
31. **CUSTOMER_SPA_ARCHITECTURE.md** - Superseded by MASTER_PLAN
|
||||
|
||||
#### Other
|
||||
32. **PLUGIN_ZIP_GUIDE.md** - Just created, can be deleted (packaging automated)
|
||||
|
||||
---
|
||||
|
||||
### 📦 MERGE - Consolidate Related (6 files)
|
||||
|
||||
#### Shipping Documentation → Create `SHIPPING_INTEGRATION.md`
|
||||
1. **RAJAONGKIR_INTEGRATION.md** - RajaOngkir integration
|
||||
2. **BITESHIP_ADDON_SPEC.md** - Biteship addon spec
|
||||
→ **Merge into**: `SHIPPING_INTEGRATION.md` (shipping addons guide)
|
||||
|
||||
#### Customer SPA → Keep only `CUSTOMER_SPA_MASTER_PLAN.md`
|
||||
3. **CUSTOMER_SPA_ARCHITECTURE.md** - Architecture details
|
||||
4. **CUSTOMER_SPA_SETTINGS.md** - Settings details
|
||||
5. **CUSTOMER_SPA_STATUS.md** - Status updates
|
||||
6. **CUSTOMER_SPA_THEME_SYSTEM.md** - Theme system
|
||||
→ **Action**: Delete 3-6, keep only MASTER_PLAN
|
||||
|
||||
---
|
||||
|
||||
### 📝 UPDATE - Needs Refresh (18 files remaining)
|
||||
|
||||
Files to keep but may need updates as features evolve.
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Cleanup Actions
|
||||
|
||||
### Phase 1: Delete Obsolete (32 files)
|
||||
```bash
|
||||
# Completed fixes
|
||||
rm FIXES_APPLIED.md REAL_FIX.md CANONICAL_REDIRECT_FIX.md
|
||||
rm HEADER_FIXES_APPLIED.md FINAL_FIXES.md FINAL_FIXES_APPLIED.md
|
||||
rm FIX_500_ERROR.md HASHROUTER_FIXES.md INLINE_SPACING_FIX.md
|
||||
rm DIRECT_ACCESS_FIX.md
|
||||
|
||||
# Completed features
|
||||
rm APPEARANCE_MENU_RESTRUCTURE.md SETTINGS-RESTRUCTURE.md
|
||||
rm HEADER_FOOTER_REDESIGN.md TYPOGRAPHY-PLAN.md
|
||||
rm CUSTOMER_SPA_SETTINGS.md CUSTOMER_SPA_STATUS.md
|
||||
rm CUSTOMER_SPA_THEME_SYSTEM.md CUSTOMER_SPA_ARCHITECTURE.md
|
||||
|
||||
# Product page
|
||||
rm PRODUCT_PAGE_VISUAL_OVERHAUL.md PRODUCT_PAGE_FINAL_STATUS.md
|
||||
rm PRODUCT_PAGE_REVIEW_REPORT.md PRODUCT_PAGE_ANALYSIS_REPORT.md
|
||||
rm PRODUCT_CART_COMPLETE.md
|
||||
|
||||
# Meta/compat
|
||||
rm IMPLEMENTATION_PLAN_META_COMPAT.md METABOX_COMPAT.md
|
||||
|
||||
# Old audits
|
||||
rm DOCS_AUDIT_REPORT.md
|
||||
|
||||
# Shipping research
|
||||
rm SHIPPING_ADDON_RESEARCH.md SHIPPING_FIELD_HOOKS.md
|
||||
|
||||
# Process docs
|
||||
rm DEPLOYMENT_GUIDE.md TESTING_CHECKLIST.md TROUBLESHOOTING.md
|
||||
|
||||
# Other
|
||||
rm PLUGIN_ZIP_GUIDE.md
|
||||
```
|
||||
|
||||
### Phase 2: Merge Shipping Docs
|
||||
```bash
|
||||
# Create consolidated shipping guide
|
||||
cat RAJAONGKIR_INTEGRATION.md BITESHIP_ADDON_SPEC.md > SHIPPING_INTEGRATION.md
|
||||
# Edit and clean up SHIPPING_INTEGRATION.md
|
||||
rm RAJAONGKIR_INTEGRATION.md BITESHIP_ADDON_SPEC.md
|
||||
```
|
||||
|
||||
### Phase 3: Update Package Script
|
||||
Update `scripts/package-zip.mjs` to exclude `*.md` files from production zip.
|
||||
|
||||
---
|
||||
|
||||
## 📊 Results
|
||||
|
||||
| Category | Before | After | Reduction |
|
||||
|----------|--------|-------|-----------|
|
||||
| Total Files | 74 | 20 | 73% |
|
||||
| Essential Docs | 18 | 18 | - |
|
||||
| Obsolete | 32 | 0 | 100% |
|
||||
| Merged | 6 | 1 | 83% |
|
||||
|
||||
**Final Documentation Set**: 20 essential files
|
||||
- Core: 4 files
|
||||
- Architecture: 5 files
|
||||
- System Guides: 5 files
|
||||
- Active Plans: 4 files
|
||||
- Shipping: 1 file (merged)
|
||||
- Addon Development: 1 file (merged)
|
||||
|
||||
---
|
||||
|
||||
## ✅ Benefits
|
||||
|
||||
1. **Clarity** - Only relevant, up-to-date documentation
|
||||
2. **Maintainability** - Less docs to keep in sync
|
||||
3. **Onboarding** - Easier for new developers
|
||||
4. **Focus** - Clear what's active vs historical
|
||||
5. **Size** - Smaller plugin zip (no obsolete docs)
|
||||
Reference in New Issue
Block a user