Skip to content

Document visual diffs mode in web editor #5033

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
+19 −1
Open

Document visual diffs mode in web editor #5033

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
20 changes: 19 additions & 1 deletion editor/publish.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Publish changes in the web editor"
sidebarTitle: "Publish"
description: "Save your work and publish changes to your documentation site."
keywords: ["editor", "publish", "changes", "branches", "pull requests"]
keywords: ["editor", "publish", "changes", "branches", "pull requests", "visual diffs", "review changes"]
---

## Publishing workflows
Expand Down Expand Up @@ -49,6 +49,24 @@

To discard changes, click **Undo changes** beside a filename in the files changed dropdown.

### Review changes with visual diffs

Before publishing, you can review your changes using visual diffs mode. Visual diffs show you the rendered output of your changes side by side, so you can see exactly how your documentation will look instead of reading raw MDX code.

Check warning on line 54 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L54 

Avoid using 'will'.

To use visual diffs:

1. Click the files changed indicator in the toolbar to open the changes panel.
2. Select a file to view its diff.
3. Toggle between **Visual** and **Code** diff modes at the top of the diff view.

**Visual mode** renders the before and after versions of the page so you can compare the visual output directly. Added content is highlighted in green and removed content is highlighted in red.

Check warning on line 62 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L62 

In general, use active voice instead of passive voice ('is highlighted').

Check warning on line 62 in editor/publish.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/publish.mdx#L62 

In general, use active voice instead of passive voice ('is highlighted').

**Code mode** shows the raw MDX changes in a traditional code diff format.

<Tip>
Use visual diffs to catch formatting issues, verify component rendering, and review content changes in context before publishing.
</Tip>

### Publish your changes

Click **Publish** in the toolbar. Depending on your workflow, your changes deploy immediately or create a pull request for you to merge in your Git provider. If you are on a feature branch, save your changes before publishing.
Expand Down
Loading