Skip to content

Document auto-generated API page previews in the web editor#5080

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/doc-generated-pages-1775085273
Closed

Document auto-generated API page previews in the web editor#5080
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/doc-generated-pages-1775085273

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 1, 2026

Summary

  • Documents the new auto-generated API page preview feature in the web editor
  • Updates editor/pages.mdx with a section explaining that OpenAPI-referenced endpoints now appear as read-only preview pages
  • Updates editor/navigation.mdx with a section explaining the locked navigation behavior for auto-generated pages

The web editor now generates and displays preview pages for each endpoint when your navigation references an OpenAPI specification. These pages are read-only — users can preview API documentation content directly in the editor without deploying, but cannot edit, rename, delete, or reorder the generated pages.


Note

Low Risk
Low risk documentation-only change that adds guidance for a new editor behavior without touching runtime code.

Overview
Adds documentation for auto-generated API page previews in the web editor when navigation references an OpenAPI spec.

Explains that generated endpoint pages appear in the navigation tree for preview, and that these pages (and their parent groups) are locked/read-only—they can’t be edited, renamed, reordered, or deleted; customization happens via the OpenAPI spec (x-mint) or docs.json/spec updates.

Written by Cursor Bugbot for commit 7bfe8df. This will update automatically on new commits. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 1, 2026, 11:18 PM

@ethanpalm ethanpalm closed this Apr 2, 2026
@ethanpalm ethanpalm deleted the mintlify/doc-generated-pages-1775085273 branch April 2, 2026 00:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant