docs: add a name mnemonic to every module README and the root modules table

This commit is contained in:
2026-10-11 00:26:20 +02:00
parent 5e3c552aa1
commit ca1443e9c8
25 changed files with 74 additions and 26 deletions

View File

@@ -4,6 +4,8 @@ Background jobs on River over the shared Postgres pool: transactional dispatch,
`import "git.golem15.com/golem15/summercms/modules/conga"`
**Name:** A line of dancers moving one after another; jobs queue up and are worked through in order.
## Overview
conga is the SummerCMS counterpart of the WinterCMS queue plus the apparatus job manager. Plugins describe background work as typed job functions wrapped by `conga.Job` and return them from `pact.HasJobs`, so plugin code never imports River. A caller dispatches a job with `conga.Manager.Dispatch` inside its own write transaction: the `summer_jobs` record row and the River job are written on the same `*sql.Tx`, so a rollback leaves neither behind. River only executes the work; the record row is what progress, outcome and cancellation reads use.