docs(10.2-02): document framework modules

- Add concise code-derived onboarding for all nested modules\n- Name a real entry point and current consumers per package
This commit is contained in:
Jakub Zych
2026-09-28 13:07:52 +02:00
parent 3035ea1749
commit 680a61cde2
18 changed files with 54 additions and 0 deletions

View File

@@ -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`.

View File

@@ -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`.

View File

@@ -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`.

View File

@@ -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`.

3
modules/cabana/README.md Normal file
View File

@@ -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`.

View File

@@ -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`.

View File

@@ -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`.

View File

@@ -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`.

3
modules/lagoon/README.md Normal file
View File

@@ -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`.

3
modules/pact/README.md Normal file
View File

@@ -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`.

3
modules/party/README.md Normal file
View File

@@ -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`.

View File

@@ -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`.

View File

@@ -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`.

3
modules/surf/README.md Normal file
View File

@@ -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`.

3
modules/tide/README.md Normal file
View File

@@ -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`.

3
modules/towel/README.md Normal file
View File

@@ -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`.

3
modules/wire/README.md Normal file
View File

@@ -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`.

View File

@@ -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`.