Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Steve Piercy <[email protected]>
  • Loading branch information
sneridagh and stevepiercy authored Jan 22, 2025
1 parent f34456a commit cd4dbfe
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/registry/docs/how-to-guides/register-routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand All @@ -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.
```

Expand Down

0 comments on commit cd4dbfe

Please sign in to comment.