docs: add a name mnemonic to every module README and the root modules table
This commit is contained in:
@@ -4,6 +4,8 @@ HTTP routing for SummerCMS: collects plugin routes and named middleware into a `
|
||||
|
||||
`import "git.golem15.com/golem15/summercms/modules/surf"`
|
||||
|
||||
**Name:** Catching the incoming waves; it routes incoming HTTP requests to their handlers.
|
||||
|
||||
## Overview
|
||||
|
||||
surf turns the routes that plugins declare through `pact.HasRoutes` into one `http.Handler`. `surf.BuildRouter` registers the built-in and plugin middleware, walks every plugin's route declarations through a Laravel-style group builder (`surf.Router`, implementing `pact.Router`), mounts the [cabana](../cabana/README.md) admin, and checks every route at boot; `surf.Assemble` then compiles the result onto a standard library ServeMux. Configuration mistakes such as duplicate routes, unknown middleware names or malformed throttles fail at boot, not on the first request. It is the counterpart of WinterCMS's plugin `routes.php` files with Laravel's `Route::group`, `->middleware()`, `->where()` and `throttle` middleware.
|
||||
|
||||
Reference in New Issue
Block a user