Document auto-generated API page previews in the web editor#5080
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Document auto-generated API page previews in the web editor#5080mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
editor/pages.mdxwith a section explaining that OpenAPI-referenced endpoints now appear as read-only preview pageseditor/navigation.mdxwith a section explaining the locked navigation behavior for auto-generated pagesThe 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) ordocs.json/spec updates.Written by Cursor Bugbot for commit 7bfe8df. This will update automatically on new commits. Configure here.