Skip to content

Modules Documentation

Work in Progress — This section is currently being updated to standardize module layouts, roles, and workflows. We will be updating this content from time to time.

BigLedger Module Documentation

BigLedger is organised into modules — business-focused groupings of the applets that work together to do a job. An applet can belong to more than one module: the Tax Configuration applet is needed by accounting, sales, purchasing, e-commerce and the till alike, and it is documented once, in /applets/, with every module linking to it.

Module membership is an editorial judgement, and it is written down. BigLedger’s own data holds no module↔applet relationship — the link table is empty — so which applets belong to which module is a decision the documentation makes rather than a fact it reads. The decision, its reasoning and the places where it is genuinely ambiguous are recorded in planning/specs/module-applet-membership.md, and each module page lists the applets it owns and the applets it depends on separately.

All Modules

Foundation

Revenue & Customer Operations

Supply Chain & Operations

Compliance & Specialized


Standard structure

Every module hub page carries the same four things:

  1. What the module is for, in terms traceable to the applets beneath it.
  2. Applets in this module — every one linked, with a sentence on what it is for, and any registry applet that has no page yet named as a gap rather than omitted.
  3. What actually happens — for a module whose documents reach the ledger, which ones post and which only record.
  4. What this module needs from others — the dependency view, linked across modules.

Beneath the hub sit Concepts, Configuration, Use cases, Reports, Best practices, Related applets and API reference. A page that carries a sources: map in its front matter has been grounded against the applet pages and the backend; one that does not has not yet been through that pass.