Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
"pages": [
"editor/git-essentials",
"editor/pages",
"editor/inline-ai",
"editor/media",
"editor/navigation",
"editor/configurations",
Expand Down
5 changes: 5 additions & 0 deletions editor/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
alt="Decorative image in dark mode"
/>

Create, edit, and publish documentation directly in your browser with the web editor. View and share previews of your changes; manage your site's navigation structure with drag-and-drop components; and publish updates using your team's preferred workflow.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

Check warning on line 20 in editor/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/index.mdx#L20

Use semicolons judiciously.

## Key features

Expand All @@ -27,6 +27,7 @@
- **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files.
- **Git synchronization**: All changes sync automatically with your documentation repository.
- **Team collaboration**: Multiple team members can work simultaneously with branch-based workflows.
- **AI editing**: Generate, rewrite, and restructure content using AI without leaving the editor.

## Get started

Expand All @@ -46,6 +47,10 @@
Preview your site in real time as you edit.
</Card>

<Card title="Edit with AI" icon="sparkles" horizontal href="/editor/inline-ai">
Generate, rewrite, and restructure content using AI.
</Card>

## Publish and collaborate

<Card title="Publish changes" icon="rocket" horizontal href="/editor/publish">
Expand Down
58 changes: 58 additions & 0 deletions editor/inline-ai.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "Edit with AI"
description: "Use AI to write, rewrite, and restructure content in the visual editor."
keywords: ["ai", "inline", "editing", "improve writing", "auto structure", "ask ai"]
---

<Note>
Inline AI editing is available in visual mode only. Switch to visual mode using the toggle in the editor toolbar.
</Note>

Use inline AI editing to generate new content, improve existing content, or restructure sections without leaving the visual editor. AI changes appear as a highlighted diff so you can review them before making any changes.

## Start an AI editing session

There are four ways to start an AI editing session:

- **<kbd>Space</kbd> on an empty line**: Press <kbd>Space</kbd> on an empty paragraph to open the AI prompt.
- **Slash command**: Type <kbd>/</kbd> and select **Ask AI** from the menu.
- **Text toolbar**: Select text, then click the <Icon icon="sparkles" /> sparkle icon in the floating toolbar to choose an AI action.
- **Block menu**: Click the drag handle next to any block and select **Ask AI**.

## Skills

### Ask AI

Type an instruction for the AI to follow. Use this for any edit that doesn't fit a preset action, such as translating text, adding examples, or rewriting for a different audience.

When you use the Ask AI skill on an empty paragraph, AI generates new content. When you use the Ask AI skill on existing content, AI edits the selected content based on your prompt.

### Improve writing

Select text and choose **Improve writing** from the text toolbar for the AI to refine grammar, clarity, and tone while preserving your meaning.

### Optimize structure

Select text and choose **Optimize structure** from the text toolbar for the AI to reorganize the selected content into a clearer structure using appropriate headings, lists, or other formatting.

## Review and apply changes

After you submit a prompt, AI streams its response directly into the editor. The editor highlights any insertions and deletions with diff marks so you can review the changes.

When the AI finishes, the floating prompt bar shows a summary of the changes along with action buttons:

- **Apply** <Icon icon="check" />: Accept the changes and save them to the document. You can also press <kbd>Enter</kbd> to apply.
- **Undo** <Icon icon="undo-2" />: Revert the changes and restore the original content.
- **Retry** <Icon icon="refresh-cw" />: Discard the current result and run the same prompt again.

Press <kbd>Esc</kbd> at any time to discard the AI session and restore the original content.

## Edit your prompt

The prompt input stays visible while the AI generates its response. Refine your instruction and resubmit if the result doesn't match what you expected:

1. Click **Undo** <Icon icon="undo-2" /> to revert the current changes.
2. Edit the prompt text in the input field.
3. Press <kbd>Enter</kbd> or click the submit button to run the updated instruction.

If the AI returns an error, click **Retry** <Icon icon="refresh-cw" /> to try again or edit the prompt and resubmit.
Loading