- Revised README and system overview documentation to clarify the introduction of a 12-hour safety TTL for cache invalidation alongside CDC events. - Enhanced explanations regarding the caching strategy for services, emphasizing the importance of the safety TTL in maintaining data freshness and self-healing capabilities. - Updated comments in the OrdersCacheService to align with the new caching approach, ensuring consistency across documentation and code.
Portal Guides (How It Works)
These guides explain what the portal does, how data moves between WHMCS and Salesforce, and where caching affects what people see. They avoid deep implementation detail and focus on flows, data ownership, and error handling.
Start with system-overview.md, then jump into the feature you care about.
Guides
| Guide | Description |
|---|---|
| Complete Guide | Single, end-to-end explanation of how the portal works |
| System Overview | High-level architecture, data ownership, and caching |
| Accounts & Identity | Sign-up, WHMCS linking, and address/profile updates |
| Services & Checkout | Product source, pricing, and checkout flow |
| Eligibility & Verification | Internet eligibility + SIM ID verification |
| Orders & Provisioning | Order lifecycle in Salesforce → WHMCS fulfillment |
| Billing & Payments | Invoices, payment methods, billing links |
| Subscriptions | How active services are read and refreshed |
| Support Cases | Case creation/reading in Salesforce |
| Dashboard & Notifications | Dashboard status model + in-app notification triggers |
| UI Design System | UI tokens, page shells, component patterns |
Related Documentation
- Salesforce Requirements – Required fields, flows, and setup
- Architecture Overview – System design