4f087d5c4c
- Updated pnpm-lock.yaml to include new dependencies and ensure consistent package versions. - Refactored order handling in OrderOrchestrator to utilize centralized field mapping for Salesforce queries. - Modified SalesforceOrder interface to replace Order_Type__c with Type for clarity. - Improved error handling in UsersService during WHMCS updates to provide user-friendly messages. - Enhanced BillingPage and ProfilePage components to streamline address management and improve user experience. - Updated documentation to reflect changes in address handling and system architecture.
67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
# 📚 Customer Portal Documentation
|
|
|
|
## 🚀 Quick Start
|
|
|
|
- **[Getting Started](GETTING_STARTED.md)** - Environment setup and initial configuration
|
|
- **[Development Commands](RUN.md)** - Daily development workflow
|
|
- **[Production Deployment](DEPLOY.md)** - Docker deployment guide
|
|
|
|
## 🏗️ Architecture & Systems
|
|
|
|
- **[Address System](ADDRESS_SYSTEM.md)** - Complete address management documentation
|
|
- **[Product Catalog Architecture](PRODUCT-CATALOG-ARCHITECTURE.md)** - SKU-based catalog system
|
|
- **[Portal Data Model](PORTAL-DATA-MODEL.md)** - Database schema and relationships
|
|
- **[Ordering & Provisioning](PORTAL-ORDERING-PROVISIONING.md)** - Order processing flow
|
|
- **[System Structure](STRUCTURE.md)** - Overall system architecture
|
|
|
|
## 🔧 Technical References
|
|
|
|
- **[Logging](LOGGING.md)** - Logging standards and practices
|
|
- **[Salesforce Products](SALESFORCE-PRODUCTS.md)** - Product configuration in Salesforce
|
|
- **[Portal Roadmap](PORTAL-ROADMAP.md)** - Future development plans
|
|
|
|
## 📋 Documentation Standards
|
|
|
|
### When to Update Documentation
|
|
|
|
- **New Features**: Update relevant architecture docs
|
|
- **API Changes**: Update technical references
|
|
- **Configuration Changes**: Update getting started guide
|
|
- **Deployment Changes**: Update deployment guide
|
|
|
|
### Documentation Structure
|
|
|
|
```
|
|
docs/
|
|
├── README.md # This index
|
|
├── GETTING_STARTED.md # Setup & configuration
|
|
├── RUN.md # Development commands
|
|
├── DEPLOY.md # Production deployment
|
|
├── ADDRESS_SYSTEM.md # Address management
|
|
├── PRODUCT-CATALOG-ARCHITECTURE.md # Catalog system
|
|
├── PORTAL-DATA-MODEL.md # Database schema
|
|
├── PORTAL-ORDERING-PROVISIONING.md # Order processing
|
|
├── STRUCTURE.md # System architecture
|
|
├── LOGGING.md # Logging practices
|
|
├── SALESFORCE-PRODUCTS.md # SF configuration
|
|
└── PORTAL-ROADMAP.md # Future plans
|
|
```
|
|
|
|
## 🎯 Key Principles
|
|
|
|
### Clean Documentation
|
|
- ✅ **Single source of truth** - No redundant docs
|
|
- ✅ **Up-to-date** - Reflects current implementation
|
|
- ✅ **Practical** - Includes real code examples
|
|
- ✅ **Organized** - Clear structure and navigation
|
|
|
|
### Developer Experience
|
|
- ✅ **Quick reference** - Essential info easily accessible
|
|
- ✅ **Complete examples** - Working code snippets
|
|
- ✅ **Troubleshooting** - Common issues and solutions
|
|
- ✅ **Testing guidance** - How to verify implementations
|
|
|
|
---
|
|
|
|
*This documentation reflects the current clean, modern implementation of the Customer Portal system.*
|