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 @@ HTTP parity toolkit that records request and response fixtures from a reference
`import "git.golem15.com/golem15/summercms/modules/tide"`
**Name:** The tide goes out and comes back, and you compare the waterline; it records traffic from one backend, replays it against another and compares.
## Overview
`tide` is the acceptance-test engine for porting an existing WinterCMS or other PHP backend to SummerCMS: the reference backend's real responses define the contract, and the Go port must reproduce them. It records YAML fixtures (flows of request and response steps) either by driving a spec against a target or by sitting as a loopback reverse proxy in front of the reference backend while a real client uses it, then replays those fixtures against the port and diffs the responses after masking values that legitimately differ, such as IDs and timestamps. It also checks realtime side effects: a fake Centrifugo recorder captures the publications a backend sends while a flow runs, and broadcast golden files hold them normalised for comparison. Upstream sidecars record the calls a backend makes to outside vendors, through a loopback HTTPS recording proxy, and replay them offline through an asserting fake. The `summer` CLI's parity:proxy, parity:record, parity:replay, parity:broadcasts and parity:upstream commands are thin wrappers around this package. It has no WinterCMS counterpart.