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-push

With routeMode: "docs-root", the docs set owns /plugins/payload-markdown-docs and descendants. A normal Page at /plugins can still exist if the group uses pageMode: "custom".

With routeMode: "product-nested", the docs set owns /plugins/payload-markdown-docs/docs and descendants. The parent /plugins/payload-markdown-docs route can be owned by Pages or the host app.

With pageMode: "auto", a group claims its route, such as /plugins, for a generated card index. With pageMode: "custom", the group route is not claimed.

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.