From cd4dbfe452b769a47b50b8e4a563a33def96812b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADctor=20Fern=C3=A1ndez=20de=20Alba?= Date: Wed, 22 Jan 2025 11:52:25 +0100 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Steve Piercy --- packages/registry/docs/how-to-guides/register-routes.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/registry/docs/how-to-guides/register-routes.md b/packages/registry/docs/how-to-guides/register-routes.md index 67f286ac27..41b79656c0 100644 --- a/packages/registry/docs/how-to-guides/register-routes.md +++ b/packages/registry/docs/how-to-guides/register-routes.md @@ -11,7 +11,8 @@ myst: The `config.registerRoute` method adds a route to the configuration registry. It saves the routes in the `config.routes` key in the configuration object. -You should provide one route at a time and must have the following shape: +You should provide one route at a time. +Each route must have the following data shape. ```ts type ReactRouterRouteEntry = { @@ -32,8 +33,8 @@ The `type` key specifies the route type to create, specifically one of `route`, The type `route` can contain nested routes. ```{info} -The routes registered with this method are intended to be React Router 7 compliant routes. -They are meant to be loaded via a helper provided by `@plone/react-router` in an existing React Router 7 app. +The routes registered with this method must be compliant with React Router 7 routes. +They are loaded by a helper provided by `@plone/react-router` in an existing React Router 7 app. Check the official [React Router 7 documentation](https://reactrouter.com/start/framework/routing) for more information on how to define React Router 7 routes. ```