diff --git a/editor/navigation.mdx b/editor/navigation.mdx index 16e0fd10d..f7a316265 100644 --- a/editor/navigation.mdx +++ b/editor/navigation.mdx @@ -25,6 +25,12 @@ To ungroup pages within a group or other navigation element, right-click then cl Some elements cannot nest inside other elements. For example, tabs cannot nest inside groups. The web editor prevents you from nesting invalid elements. +### Auto-generated API pages + +When a navigation element references an [OpenAPI specification](/api-playground/openapi-setup#auto-populate-api-pages), the web editor automatically populates the navigation tree with pages for each endpoint in the spec. This lets you preview your full API documentation structure directly in the editor. + +Auto-generated pages and their parent groups are locked. You cannot reorder, rename, or delete them through drag-and-drop or context menus. To change the structure of auto-generated API pages, update your OpenAPI specification or your `docs.json` configuration. + ### Add existing files Add files from your repository that aren't yet in navigation. diff --git a/editor/pages.mdx b/editor/pages.mdx index dde35205d..7895147a0 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -31,6 +31,12 @@ Switch between visual and Markdown mode with the toggle in the toolbar. The web API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. You can view their contents but cannot edit them directly. To update a spec file, edit it using your preferred code editor and push the changes to your documentation repository. +### Auto-generated API pages + +When your navigation references an [OpenAPI specification](/api-playground/openapi-setup#auto-populate-api-pages), the web editor generates preview pages for each endpoint directly in the navigation tree. These pages let you see how your API documentation looks without deploying. + +Auto-generated API pages are read-only. You can click them to preview their content, but you cannot edit the page content, rename, delete, or reorder them. To customize an auto-generated page, use the [`x-mint` extension](/api-playground/openapi-setup#customize-your-endpoint-pages) in your OpenAPI specification or [create an MDX page](/api-playground/openapi-setup#create-mdx-pages-from-your-openapi-specification) for the endpoint. +