diff --git a/modules/backpack/README.md b/modules/backpack/README.md new file mode 100644 index 0000000..1fbf3d2 --- /dev/null +++ b/modules/backpack/README.md @@ -0,0 +1,3 @@ +# backpack + +`backpack` provides the application container that holds configuration, services, events, and activated plugin IDs. Framework boot code and Fonoteka plugin assembly import it; start with `backpack.App` and `backpack.New` in `app.go`. diff --git a/modules/boardwalk/README.md b/modules/boardwalk/README.md new file mode 100644 index 0000000..9804461 --- /dev/null +++ b/modules/boardwalk/README.md @@ -0,0 +1,3 @@ +# boardwalk + +`boardwalk` serves the embedded admin SPA, including its configured path prefix, client-route fallback, cache headers, and API miss handoff. `cabana` imports it while activating admin routes; use `boardwalk.Handler` from `boardwalk.go`. diff --git a/modules/bonfire/README.md b/modules/bonfire/README.md new file mode 100644 index 0000000..39a03a7 --- /dev/null +++ b/modules/bonfire/README.md @@ -0,0 +1,3 @@ +# bonfire + +`bonfire` adapts framework and plugin commands to Cobra, with typed command input, flags, and output helpers. The Summer CLI, `cabana`, `lagoon`, and Fonoteka plugins import it; begin with `bonfire.NewRoot` in `root.go`. diff --git a/modules/bouncer/README.md b/modules/bouncer/README.md new file mode 100644 index 0000000..99f61d6 --- /dev/null +++ b/modules/bouncer/README.md @@ -0,0 +1,3 @@ +# bouncer + +`bouncer` supplies authentication guards, JWT minting and verification, password helpers, and blacklist storage. `surf`, `cabana`, and Fonoteka API plugins import it to protect routes; use `bouncer.NewJWTGuard` in `jwt.go`. diff --git a/modules/cabana/README.md b/modules/cabana/README.md new file mode 100644 index 0000000..ccac4f9 --- /dev/null +++ b/modules/cabana/README.md @@ -0,0 +1,3 @@ +# cabana + +`cabana` implements the schema-driven admin API: authentication, controller schemas, CRUD, relations, settings, and OpenAPI DTOs. Fonoteka's admin controllers and framework routing import it; start the assembled surface with `cabana.Activate` in `http.go`. diff --git a/modules/compass/README.md b/modules/compass/README.md new file mode 100644 index 0000000..a0e9432 --- /dev/null +++ b/modules/compass/README.md @@ -0,0 +1,3 @@ +# compass + +`compass` loads layered YAML and environment configuration, including plugin configuration files and runtime values. The framework runtime and Fonoteka application boot import it; create a configuration tree with `compass.Open` in `config.go`. diff --git a/modules/festival/README.md b/modules/festival/README.md new file mode 100644 index 0000000..13ba19c --- /dev/null +++ b/modules/festival/README.md @@ -0,0 +1,3 @@ +# festival + +`festival` is the framework event bus, supporting collection and handler registration for application events. `backpack` and example plugins import it during boot; create a bus with `festival.New` in `bus.go`. diff --git a/modules/fetchguard/README.md b/modules/fetchguard/README.md new file mode 100644 index 0000000..a661786 --- /dev/null +++ b/modules/fetchguard/README.md @@ -0,0 +1,3 @@ +# fetchguard + +`fetchguard` performs policy-controlled outbound HTTP fetches with size, timeout, and address safety checks. No current in-repository package imports it directly; its public entry point is `fetchguard.Fetch` in `fetch.go`. diff --git a/modules/lagoon/README.md b/modules/lagoon/README.md new file mode 100644 index 0000000..0749e1d --- /dev/null +++ b/modules/lagoon/README.md @@ -0,0 +1,3 @@ +# lagoon + +`lagoon` contains the GORM/Postgres data primitives: connection setup, migrations, validation, pagination, encryption, lifecycle hooks, and attachment support. Framework runtime code and Fonoteka plugins import it; open the shared database handles with `lagoon.Open` in `connection.go`. diff --git a/modules/pact/README.md b/modules/pact/README.md new file mode 100644 index 0000000..fefdfc1 --- /dev/null +++ b/modules/pact/README.md @@ -0,0 +1,3 @@ +# pact + +`pact` defines the compiled-plugin capability contracts for routes, configuration, migrations, middleware, admin controllers, permissions, and jobs. `party`, `surf`, `cabana`, and Fonoteka plugins import these interfaces; see `pact.AdminController` in `capabilities.go`. diff --git a/modules/party/README.md b/modules/party/README.md new file mode 100644 index 0000000..4a2cc70 --- /dev/null +++ b/modules/party/README.md @@ -0,0 +1,3 @@ +# party + +`party` registers compiled plugins and coordinates their framework-facing capabilities, translations, mail drivers, and metadata. The application runtime and framework services import it to discover plugins; start with `party.Registry` in `registry.go`. diff --git a/modules/phrasebook/README.md b/modules/phrasebook/README.md new file mode 100644 index 0000000..6927b6e --- /dev/null +++ b/modules/phrasebook/README.md @@ -0,0 +1,3 @@ +# phrasebook + +`phrasebook` loads and translates plugin locale messages while preserving the application's requested locale. `party`, `cabana`, `lagoon`, and Fonoteka controllers import it; use `phrasebook.Translator` from `translator.go`. diff --git a/modules/postcard/README.md b/modules/postcard/README.md new file mode 100644 index 0000000..2b22d43 --- /dev/null +++ b/modules/postcard/README.md @@ -0,0 +1,3 @@ +# postcard + +`postcard` renders and delivers mail through configured memory, log, SMTP, and template drivers. `party` and Fonoteka's user plugin import it for account mail; configure delivery with `postcard.NewSMTPDriver` in `drivers.go`. diff --git a/modules/surf/README.md b/modules/surf/README.md new file mode 100644 index 0000000..e93a88e --- /dev/null +++ b/modules/surf/README.md @@ -0,0 +1,3 @@ +# surf + +`surf` builds the HTTP router and middleware stack, including route constraints, recovery, CORS, body limits, rate limits, and server commands. The Summer runtime and Fonoteka application import it to expose plugin routes; assemble the router with `surf.BuildRouter` in `router.go`. diff --git a/modules/tide/README.md b/modules/tide/README.md new file mode 100644 index 0000000..1234853 --- /dev/null +++ b/modules/tide/README.md @@ -0,0 +1,3 @@ +# tide + +`tide` records, replays, normalizes, and compares HTTP parity fixtures for the PHP-to-Go migration. The Summer parity CLI and Fonoteka parity tests import it; a fixture flow is represented by `tide.Flow` in `flow.go`. diff --git a/modules/towel/README.md b/modules/towel/README.md new file mode 100644 index 0000000..c831b13 --- /dev/null +++ b/modules/towel/README.md @@ -0,0 +1,3 @@ +# towel + +`towel` carries request-scoped actor, organization, collection, and locale values through `context.Context`. Admin schema and controller code import it while processing scoped requests; set an actor with `towel.WithActor` in `context.go`. diff --git a/modules/wire/README.md b/modules/wire/README.md new file mode 100644 index 0000000..bd319e8 --- /dev/null +++ b/modules/wire/README.md @@ -0,0 +1,3 @@ +# wire + +`wire` writes JSON response envelopes and normalizes optional slices for stable API serialization. `surf` and Fonoteka API controllers import it for HTTP responses; use `wire.WriteJSON` from `response.go`. diff --git a/modules/wristband/README.md b/modules/wristband/README.md new file mode 100644 index 0000000..707c651 --- /dev/null +++ b/modules/wristband/README.md @@ -0,0 +1,3 @@ +# wristband + +`wristband` implements the MCP OAuth server surface: client registration, authorization, consent, token issuance, and backing-store contracts. Fonoteka's OAuth plugin and API controllers import it; the server entry point is `wristband.Server` in `server.go`.