diff --git a/editor/publish.mdx b/editor/publish.mdx index 6a997f271..c134cc812 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -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 @@ -49,6 +49,24 @@ When you work on a feature branch, save changes to the branch. 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. + +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. + +**Code mode** shows the raw MDX changes in a traditional code diff format. + + + Use visual diffs to catch formatting issues, verify component rendering, and review content changes in context before publishing. + + ### 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.