Skip to content

Document API spec file upload in web editor #5222

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Document API spec file upload in web editor #5222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion editor/pages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
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.
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. You can view their contents but cannot edit them inline. To update a spec file, upload a replacement file in the web editor or edit it using your preferred code editor and push the changes to your documentation repository.

Check warning on line 31 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L31 

In general, use active voice instead of passive voice ('are read').
</Note>

<Frame>
Expand Down
2 changes: 1 addition & 1 deletion editor/publish.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ As you edit, the editor tracks your changes.
- New or deleted files.
- Content edits in pages.
- Navigation structure changes.
- Media uploads and organization.
- Media and file uploads, including API specification files.
- Configuration updates.

When you work on your deployment branch, changes automatically save.
Expand Down
Loading