Skip to content

Document read-only API spec files in web editor #4908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 2 commits into from
Mar 31, 2026
Merged

Document read-only API spec files in web editor #4908

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5b3b3a
Document read-only API spec files in web editor
mintlify[bot] Mar 26, 2026
9cef361
Apply suggestion from @ethanpalm
ethanpalm Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions editor/pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Browse your documentation pages in the **Navigation** tab of the left panel.

Switch between visual and Markdown mode with the toggle in the toolbar. The web editor saves your changes when switching modes.

<Note>
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.
</Note>

<Frame>
<img
src="/images/editor/mode-toggle-light.png"
Expand Down
Loading