7c929eb4dc
- Streamlined the README.md for clarity and conciseness. - Deleted outdated documentation files related to Freebit SIM management, SIM management API data flow, and various architectural guides to reduce clutter and improve maintainability. - Updated the last modified date in the README to reflect the latest changes.
26 lines
2.0 KiB
Markdown
26 lines
2.0 KiB
Markdown
# 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](./COMPLETE-GUIDE.md) | Single, end-to-end explanation of how the portal works |
|
||
| [System Overview](./system-overview.md) | High-level architecture, data ownership, and caching |
|
||
| [Accounts & Identity](./accounts-and-identity.md) | Sign-up, WHMCS linking, and address/profile updates |
|
||
| [Catalog & Checkout](./catalog-and-checkout.md) | Product source, pricing, and checkout flow |
|
||
| [Eligibility & Verification](./eligibility-and-verification.md) | Internet eligibility + SIM ID verification |
|
||
| [Orders & Provisioning](./orders-and-provisioning.md) | Order lifecycle in Salesforce → WHMCS fulfillment |
|
||
| [Billing & Payments](./billing-and-payments.md) | Invoices, payment methods, billing links |
|
||
| [Subscriptions](./subscriptions.md) | How active services are read and refreshed |
|
||
| [Support Cases](./support-cases.md) | Case creation/reading in Salesforce |
|
||
| [UI Design System](./ui-design-system.md) | UI tokens, page shells, component patterns |
|
||
|
||
## Related Documentation
|
||
|
||
- [Salesforce Requirements](../salesforce/SALESFORCE-REQUIREMENTS.md) – Required fields, flows, and setup
|
||
- [Architecture Overview](../architecture/ARCHITECTURE.md) – System design
|