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.
69 lines
2.7 KiB
Markdown
69 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._
|