golem15/summercms
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Jakub Zych
2026-10-11 00:26:20 +02:00
parent 5e3c552aa1
commit ca1443e9c8
25 changed files with 74 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
modules/beachcomber/README.md
View File

@@ -6,6 +6,8 @@ Search index sync for GORM models: after-commit upserts and deletes through a pl
`import _ "git.golem15.com/golem15/summercms/modules/beachcomber/typesense"`
**Name:** A beachcomber searches the shore for finds; this module keeps the search index in step so content can be found.
## Overview
beachcomber is the SummerCMS counterpart of Laravel Scout as WinterCMS applications use it with `queue=false`. A model opts in by implementing `beachcomber.Searchable`. After a create, update or delete of such a model commits, the row is reloaded by primary key and its document is upserted into the engine's index, or removed from it. Sync runs inline in the writing goroutine, bounded by the engine's request timeout, and is never fatal: a failure is logged and the write stays committed.