Skip to main content
Version: 1.2

Getting Started

Welcome to the Shumoul Developer Portal — the single documentation website for the entire Shumoul Cloud ERP platform.

How this portal is organized​

  • Frameworks — one section per platform module (Notification Framework, and more as they are published). Each framework's documentation is self-contained: architecture, packages, runtime behavior, full API reference, configuration, deployment, testing, and troubleshooting.
  • APIs — a cross-framework API index, and the future home of generated OpenAPI references.
  • Guides / Tutorials / Best Practices — task-oriented content that spans more than one framework.
  • FAQ and Release Notes — portal-wide, in addition to each framework's own FAQ/appendix chapters.

Start here​

If you're integrating with the Notification Framework — the first published module — go straight to:

Use the search box in the top navigation bar — every published page on this portal is indexed and full-text searchable, including code blocks and API reference tables.

Versioning​

This portal supports versioned documentation. The version selector (when more than one version is published) appears in the top navigation bar. The current version is v1.0.