diff --git a/docs/book/v1/features.md b/docs/book/v1/features.md index f9f0d66..033d946 100644 --- a/docs/book/v1/features.md +++ b/docs/book/v1/features.md @@ -17,8 +17,8 @@ Besides the features provided by `mezzio/mezzio-fastroute`, `dot-router` offers In order to use this feature, first get an instance of the `Dot\Router\RouteCollector` using the below code: ```php -/** @var RouteCollectorInterface $routeCollector */ -$routeCollector = $container->get(RouteCollectorInterface::class); +/** @var \Dot\Router\RouteCollectorInterface $routeCollector */ +$routeCollector = $container->get(\Dot\Router\RouteCollectorInterface::class); ``` Then rewrite the above routes using the below code: @@ -36,10 +36,10 @@ When `dot-router` registers the routes, it will automatically prepend the prefix ### Advantages -- DRY: no need for repeating common route parts -- encapsulation: similar routes are grouped in a single block of code (vs each route a separate statement) -- easy path refactoring: modify all routes at once by changing only the prefix -- easy copying/moving: copying/moving an entire group makes sure that you don't accidentally omit a route +- DRY - no need for repeating common route parts +- encapsulation - similar routes are grouped in a single block of code (vs each route a separate statement) +- easy path refactoring - modify all routes at once by changing only the prefix +- easy copying/moving - copying/moving an entire group makes sure that you don't accidentally omit a route ## Exclude middleware @@ -76,5 +76,5 @@ $app->post('/product/create', [CheckOwnerMiddleware::class, CreateProductHandler ### Advantages -- extends the DRY feature of route groups by allowing to specify common middlewares only once per route +- extends the DRYness of route groups by allowing to specify common middlewares only once per route - shorter and easier-to-read route definitions diff --git a/docs/book/v1/overview.md b/docs/book/v1/overview.md index df0c711..11e13b3 100644 --- a/docs/book/v1/overview.md +++ b/docs/book/v1/overview.md @@ -4,10 +4,6 @@ Dotkernel component to build complex routes, based on [mezzio/mezzio-fastroute]( > dot-router is a wrapper on top of [mezzio/mezzio-fastroute](https://github.com/mezzio/mezzio-fastroute) -## Documentation - -Documentation is available at: https://docs.dotkernel.org/dot-router/. - ## Badges ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-router) diff --git a/docs/book/v1/tutorials/create-route-group.md b/docs/book/v1/tutorials/create-route-group.md index ccbbe77..d866615 100644 --- a/docs/book/v1/tutorials/create-route-group.md +++ b/docs/book/v1/tutorials/create-route-group.md @@ -5,8 +5,8 @@ Get an instance of the `Dot\Router\RouteCollector` using the below code: ```php -/** @var RouteCollectorInterface $routeCollector */ -$routeCollector = $container->get(RouteCollectorInterface::class); +/** @var \Dot\Router\RouteCollectorInterface $routeCollector */ +$routeCollector = $container->get(\Dot\Router\RouteCollectorInterface::class); ``` Create a route group, by setting the route group prefix and optionally a(n array of) common middleware(s): diff --git a/docs/book/v1/tutorials/create-single-route.md b/docs/book/v1/tutorials/create-single-route.md index baa7ab6..497419c 100644 --- a/docs/book/v1/tutorials/create-single-route.md +++ b/docs/book/v1/tutorials/create-single-route.md @@ -5,8 +5,8 @@ Get an instance of the `Dot\Router\RouteCollector` using the below code: ```php -/** @var RouteCollectorInterface $routeCollector */ -$routeCollector = $container->get(RouteCollectorInterface::class); +/** @var \Dot\Router\RouteCollectorInterface $routeCollector */ +$routeCollector = $container->get(\Dot\Router\RouteCollectorInterface::class); ``` ## Create a route that responds to any request method