Route Reservations
How docs groups, docs sets, docs records, and optional Pages checks avoid route collisions.
Route Reservations
Route reservations protect docs routes from colliding with other docs routes or, when configured, Pages routes.
Reservation Owners
- docs groups can reserve route namespaces
- docs sets reserve their route base and descendants
- generated docs records reserve exact generated routes
- Pages checks can be enabled from the docs side
Example
1Docs group: /plugins2Docs set: /plugins/payload-markdown-docs3Doc: /plugins/payload-markdown-docs/workflow/signed-pushThe docs set owns /plugins/payload-markdown-docs and descendants. A normal Page at /plugins can still exist if the group does not serve an index.
Pages Collision Checks
Pages collision checks are opt-in:
1payloadMarkdownDocs({2 routing: {3 pages: {4 enabled: true,5 collection: 'pages',6 routeField: 'slug',7 },8 },9})These checks do not mutate Pages and do not add Page hooks. They only help docs sync reject unsafe route collisions.
Bridge Pages are not generated
A bridge Page is an optional convention for one Page per docs set or docs group. The plugin does not create bridge Pages automatically, and it never creates one Page per Markdown doc.