0bf872e249
- Adjusted YAML and JSON files for consistent formatting, including healthcheck commands and package exports. - Enhanced readability in various TypeScript files by standardizing string quotes and improving line breaks. - Updated documentation across multiple files to improve clarity and consistency, including address system and logging levels. - Removed unnecessary package-lock.json from shared package directory to streamline dependencies.
2.7 KiB
2.7 KiB
📚 Customer Portal Documentation
🚀 Quick Start
- Getting Started - Environment setup and initial configuration
- Development Commands - Daily development workflow
- Production Deployment - Docker deployment guide
🏗️ Architecture & Systems
- Address System - Complete address management documentation
- Product Catalog Architecture - SKU-based catalog system
- Portal Data Model - Database schema and relationships
- Ordering & Provisioning - Order processing flow
- System Structure - Overall system architecture
🔧 Technical References
- Logging - Logging standards and practices
- Salesforce Products - Product configuration in Salesforce
- Portal Roadmap - 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.